micmac.likelihood.initobjects module

create_HarmonicMicmacSampler_from_MicmacSampler_obj(MICMAC_sampler_obj, depth_p_array=None)

Create a HarmonicMicmacSampler object from a MicmacSampler object

Parameters:

MICMAC_sampler_obj : MicmacSampler

MicmacSampler object

depth_p_array : array[float] of dimensions [n_pix]

depth_p_array for the noise power spectrum

Returns:

HarmonicMicmacSampler_obj – HarmonicMicmacSampler object

Return type:

HarmonicMicmacSampler

create_HarmonicMicmacSampler_from_dictionnary(dictionary_parameters, path_file_spv)

Create a HarmonicMicmacSampler object from the path of a toml file and the yaml file for spatial variability

Parameters:

dictionary_parameters : dictionary

dictionary for the main options of HarmonicMicmacSampler

path_file_spv : str

path to the yaml file for the spatial variability options

Returns:

HarmonicMicmacSampler_obj – HarmonicMicmacSampler object

Return type:

HarmonicMicmacSampler

create_HarmonicMicmacSampler_from_toml_file(path_toml_file, path_file_spv='')

Create a MicmacSampler object from: * the path of a toml file: params for the sims and for the sampling * the path of a spv file: params for addressing spatial variability

Parameters:

path_toml_file : str

path to the toml file for the main options of MicmacSampler

path_file_spv : str

path to the yaml file for the spatial variability options

Returns:

MICMAC_Sampler_obj – the MicmacSampler object created from the toml file with the spatial variability from the yaml file

Return type:

MicmacSampler

create_MicmacSampler_from_HarmonicMicmacSampler_obj(HarmonicMicmac_sampler_obj, depth_p_array=None)

Create a MicmacSampler object from a HarmonicMicmacSampler object

Parameters:

HarmonicMicmac_sampler_obj : HarmonicMicmacSampler

HarmonicMicmacSampler object

depth_p_array : array[float] of dimensions [n_pix]

depth_p_array for the noise power spectrum

Returns:

MICMAC_sampler_obj – MicmacSampler object

Return type:

MicmacSampler

create_MicmacSampler_from_dictionnary(dictionary_parameters, path_file_spv='')

Create a MicmacSampler object from: * the path of a toml file: params for the sims and for the sampling * the path of a spv file: params for addressing spatial variability

Parameters:

dictionary_parameters : dictionary

dictionary for the main options of MicmacSampler

path_file_spv : str

path to the yaml file for the spatial variability options

Returns:

MICMAC_Sampler_obj – the MicmacSampler object created from the toml file with the spatial variability from the yaml file

Return type:

MicmacSampler

create_MicmacSampler_from_toml_file(path_toml_file, path_file_spv='')

Create a MicmacSampler object from: * the path of a toml file: params for the sims and for the sampling * the path of a spv file: params for addressing spatial variability

Parameters:

path_toml_file : str

path to the toml file for the main options of MicmacSampler

path_file_spv : str

path to the yaml file for the spatial variability options

Returns:

MICMAC_Sampler_obj – the MicmacSampler object created from the toml file with the spatial variability from the yaml file

Return type:

MicmacSampler