exorad.tasks.targetHandler module

class EstimateMaxSignal[source]

Bases: Task

Updated the target output table with maximum estimated signal in pix column

Parameters:

target (Target) – target to prepare

Returns:

same target with table attribute updated

Return type:

Target

Class initialisation, needed to prepare the task inputs reader

execute()[source]

Class execution. It runs on call and executes all the task actions returning the outputs. It requires the input with correct keywords

class LoadTargetList[source]

Bases: Task

Loads target list from file

Parameters:

target_list (str) – target list file address. Supported formats are csv and xml

Returns:

return a list of Target class

Return type:

TargetList

Examples

>>> loadTargetList = LoadTargetList()
>>> targets = loadTargetList(target_list='target_list/address')

Class initialisation, needed to prepare the task inputs reader

execute()[source]

Class execution. It runs on call and executes all the task actions returning the outputs. It requires the input with correct keywords

class ObserveTarget[source]

Bases: Task

Standard pipeline for target observation. It includes: 1. PrepareTarget, 2. EstimateForegrounds, 3. PropagateForegroundLight 4. LoadSource 5. PropagateTargetLight 6. EstimateNoise

Parameters:
  • target (Target) – target to prepare

  • payload (dict) – payload description

  • channels (dict) – channel dictionary

  • wl_range ((float, float)) – wavelength range to investigate. (wl_min, wl_max)

Returns:

same target with table attribute updated

Return type:

Target

Class initialisation, needed to prepare the task inputs reader

execute()[source]

Class execution. It runs on call and executes all the task actions returning the outputs. It requires the input with correct keywords

class ObserveTargetlist[source]

Bases: Task

Standard pipeline to observe a full targetlist. It allows parallelization:

Parameters:
  • targets (Target) – targets to prepare

  • payload (dict) – payload description

  • channels (dict) – channel dictionary

  • wl_range ((float, float)) – wavelength range to investigate. (wl_min, wl_max)

  • plot (bool) – allow to save plots

  • out_dir (str) – indicate the directory where to save plots

  • n_thread (int) – number of threads

  • debug (bool) – debug mode

Returns:

targets dict

Return type:

dict

Class initialisation, needed to prepare the task inputs reader

execute()[source]

Class execution. It runs on call and executes all the task actions returning the outputs. It requires the input with correct keywords

class PrepareTarget[source]

Bases: Task

Prepares the target output table over the channels to populate with light propagation

Parameters:
  • target (Target) – target to prepare

  • channels (dict) – channel dictionary

Returns:

same target with table attribute populated

Return type:

Target

Class initialisation, needed to prepare the task inputs reader

add_metadata(table, target)[source]
execute()[source]

Class execution. It runs on call and executes all the task actions returning the outputs. It requires the input with correct keywords

class UpdateTargetTable[source]

Bases: Task

Updated the target output table over the channels to populate with light propagation

Parameters:
  • target (Target) – target to prepare

  • table (QTable) – table to merge in the target table

Returns:

same target with table attribute updated

Return type:

Target

Class initialisation, needed to prepare the task inputs reader

execute()[source]

Class execution. It runs on call and executes all the task actions returning the outputs. It requires the input with correct keywords

pipeline_to_dict(target, payload, channels, wl_range, plot, out_dir, debug)[source]

This will be executed using concurrent futures