class craftutils.observation.field.Field(craftutils.observation.epoch.Pipeline)

Public members

stage_output_dirs = False
Field(centre_coords: SkyCoord | str | None = None, ...)
Parameters
centre_coords: SkyCoord | str | None = None

name

param_path

data_path

objs

a list of objects of interest in the field. The primary object of interest should be first in

the list.

__str__()

Return str(self).

__repr__()

Return repr(self).

classmethod stages()
proc_finalise_imaging(output_dir: str, **kwargs)
proc_update_photometry(output_dir: str, **kwargs)
force_stage_all_epochs(stage: str, ...)
proc_refine_photometry(output_dir: str, **kwargs)
proc_galfit(output_dir: str, **kwargs)
get_images_band(fil: str | Filter, ...)
get_filters(instrument: str | None = None)
deepest_in_band(fil: str | Filter, ...) dict
galfit(apply_filter=None, use_img: str | None = None, ...)
proc_push_to_table(output_dir: str, **kwargs)
mkdir()
mkdir_params()
gather_objects(quiet: bool = True)
gather_epochs_spectroscopy(quiet: bool = False, ...)

Gathers all of the spectroscopy observation epochs of this field. :return: Dict, with keys being the epoch names and values being nested dictionaries containing the same information as the epoch .yaml files.

gather_epochs_imaging(quiet: bool = False, ...)

Gathers all of the imaging observation epochs of this field. :return: Dict, with keys being the epoch names and values being nested dictionaries containing the same information as the epoch .yaml files.

epoch_from_params(epoch_name: str, instrument: str)
select_epoch(mode: str, instrument: str | None = None, ...)
new_object(name: str, obj_type: str, position, ...)
new_epoch_imaging(instrument: str | None = None)
new_epoch_spectroscopy(instrument: str | None = None)
retrieve_catalogues(force_update: bool = False)
retrieve_catalogue(cat_name: str, force_update: bool = False, ...)

Retrieves and saves a catalogue of this field.

load_catalogue(cat_name: str, **kwargs)
generate_astrometry_indices(cat_name: str = 'gaia')
get_path(key)
check_cat(cat_name: str)
load_output_file(**kwargs)
load_imaging(instrument: str | None = None)
add_image(img: ImagingImage, epoch_name: str | None = None)
add_object(obj: dict | Object)
remove_object(obj: Object | str)
add_object_from_dict(obj_dict: dict)
generate_cigale_photometry()
unpack_cigale_results(cigale_dir: str)
load_all_objects()
get_object(name: str, allow_missing: bool) Object | None

Retrieves the named object from the field’s object dictionary.

classmethod default_params()
classmethod from_file(param_file: str | dict)
classmethod from_params(name, quiet: bool = False)
classmethod new_yaml(name: str, path: str | None = None, **kwargs)
classmethod build_param_path(field_name: str, mkdir: bool = True)
classmethod new_params_from_input(field_name: str, field_param_path)
stage_params : dict
add_log(action: str, method=None, method_args=None, ...)
set_path(key: str, value: str)
classmethod enumerate_stages(show: bool = True)
query_stage(message: str, stage_name: str, n: float, ...)

Helper method for asking the user if we need to do this stage of processing. If self.do is True, skips the query and returns True.

check_done(stage: str)
pipeline(no_query: bool = False, **kwargs)

Performs the pipeline methods given in stages() for this instance.

update_output_file()
update_param_file(param: str)