pipeline.hifa.tasks.gaincal package¶
Submodules¶
pipeline.hifa.tasks.gaincal.display module¶
-
class
pipeline.hifa.tasks.gaincal.display.
GaincalAmpVsTimeDetailChart
(context, result, calapps, intent)[source]¶ Bases:
pipeline.hifa.tasks.gaincal.display.GaincalDetailChart
Create a phase vs time plot for each spw/antenna combination.
-
class
pipeline.hifa.tasks.gaincal.display.
GaincalAmpVsTimeSummaryChart
(context, result, calapps, intent)[source]¶ Bases:
pipeline.hifa.tasks.gaincal.display.GaincalSummaryChart
Create an amplitude vs time plot for each spw, overplotting by antenna.
-
class
pipeline.hifa.tasks.gaincal.display.
GaincalDetailChart
(context, result, calapps, intent, xaxis, yaxis, plotrange=None, coloraxis='')[source]¶ Bases:
object
Base class for executing plotms per spw and antenna
-
class
pipeline.hifa.tasks.gaincal.display.
GaincalPhaseVsTimeDetailChart
(context, result, calapps, intent)[source]¶ Bases:
pipeline.hifa.tasks.gaincal.display.GaincalDetailChart
Create a phase vs time plot for each spw/antenna combination.
-
class
pipeline.hifa.tasks.gaincal.display.
GaincalPhaseVsTimeSummaryChart
(context, result, calapps, intent)[source]¶ Bases:
pipeline.hifa.tasks.gaincal.display.GaincalSummaryChart
Create a phase vs time plot for each spw, overplotting by antenna.
pipeline.hifa.tasks.gaincal.qa module¶
-
class
pipeline.hifa.tasks.gaincal.qa.
TimegaincalListQAHandler
[source]¶ Bases:
pipeline.infrastructure.pipelineqa.QAPlugin
QA handler for a list containing TimegaincalResults.
-
child_cls
¶
-
result_cls
¶ alias of
collections.abc.Iterable
-
-
class
pipeline.hifa.tasks.gaincal.qa.
TimegaincalQAHandler
[source]¶ Bases:
pipeline.infrastructure.pipelineqa.QAPlugin
QA handler for an uncontained TimegaincalResult.
-
child_cls
= None¶
-
result_cls
¶
-
-
class
pipeline.hifa.tasks.gaincal.qa.
TimegaincalQAPool
(qa_results_dict)[source]¶ Bases:
pipeline.infrastructure.pipelineqa.QAScorePool
-
score_types
= {'PHASE_SCORE_X2X1': ('X2X1_TOTAL', 'X2-X1 phase deviation'), 'PHASE_SCORE_XY': ('XY_TOTAL', 'X-Y phase deviation')}¶
-
short_msg
= {'PHASE_SCORE_X2X1': 'X2-X1 deviation', 'PHASE_SCORE_XY': 'X-Y deviation'}¶
-
pipeline.hifa.tasks.gaincal.renderer module¶
Created on 29 Oct 2014
@author: sjw
-
class
pipeline.hifa.tasks.gaincal.renderer.
GaincalAmpVsTimeDiagnosticPlotRenderer
(context, result, plots)[source]¶ Bases:
pipeline.infrastructure.renderer.basetemplates.JsonPlotRenderer
-
class
pipeline.hifa.tasks.gaincal.renderer.
GaincalAmpVsTimePlotRenderer
(context, result, plots)[source]¶ Bases:
pipeline.infrastructure.renderer.basetemplates.JsonPlotRenderer
-
class
pipeline.hifa.tasks.gaincal.renderer.
GaincalApplication
(ms, gaintable, calmode, solint, intent, spw, gainfield)¶ Bases:
tuple
-
property
calmode
¶ Alias for field number 2
-
property
gainfield
¶ Alias for field number 6
-
property
gaintable
¶ Alias for field number 1
-
property
intent
¶ Alias for field number 4
-
property
ms
¶ Alias for field number 0
-
property
solint
¶ Alias for field number 3
-
property
spw
¶ Alias for field number 5
-
property
-
class
pipeline.hifa.tasks.gaincal.renderer.
GaincalPhaseOffsetVsTimeDiagnosticPlotRenderer
(context, result, plots)[source]¶ Bases:
pipeline.infrastructure.renderer.basetemplates.JsonPlotRenderer
-
class
pipeline.hifa.tasks.gaincal.renderer.
GaincalPhaseVsTimeDiagnosticPlotRenderer
(context, results, plots)[source]¶ Bases:
pipeline.infrastructure.renderer.basetemplates.JsonPlotRenderer
-
class
pipeline.hifa.tasks.gaincal.renderer.
GaincalPhaseVsTimePlotRenderer
(context, result, plots)[source]¶ Bases:
pipeline.infrastructure.renderer.basetemplates.JsonPlotRenderer
-
class
pipeline.hifa.tasks.gaincal.renderer.
T2_4MDetailsGaincalRenderer
(uri='timegaincal.mako', description='Gain calibration', always_rerender=False)[source]¶ Bases:
pipeline.infrastructure.renderer.basetemplates.T2_4MDetailsDefaultRenderer
pipeline.hifa.tasks.gaincal.timegaincal module¶
-
class
pipeline.hifa.tasks.gaincal.timegaincal.
TimeGaincal
(inputs)[source]¶ Bases:
pipeline.hif.tasks.gaincal.gtypegaincal.GTypeGaincal
-
Inputs
¶ alias of
TimeGaincalInputs
-
analyse
(result)[source]¶ Determine the best parameters by analysing the given jobs before returning any final jobs to execute.
- Parameters
jobs (a list of
JobRequest
) – the job requests generated byprepare()
- Return type
Result
-
-
class
pipeline.hifa.tasks.gaincal.timegaincal.
TimeGaincalInputs
(context, vis=None, output_dir=None, calamptable=None, calphasetable=None, offsetstable=None, amptable=None, targetphasetable=None, calsolint=None, targetsolint=None, calminsnr=None, targetminsnr=None, **parameters)[source]¶ Bases:
pipeline.hif.tasks.gaincal.gtypegaincal.GTypeGaincalInputs
-
amptable
¶ VisDependentProperty is a Python data descriptor that standardises the behaviour of pipeline Inputs properties and lets them create default values more easily.
On reading a VisDependentProperty (ie. using the dot prefix: inputs.solint), one of two things happens:
If a NullMarker is found - signifying that no user input has been provided - and a ‘getter’ function has been defined, the getter function will be called to provide a default value for that measurement set.
If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.
The value, either the default from step 1 or user-provided from step 2, is run through the optional postprocess function, which gives a final opportunity to change the value depending on the state/value of other properties.
A VisDependentProperty can be made read-only by specifying ‘readonly=True’ when creating the instance.
A VisDependentProperty can be hidden from the containing Inputs string representation by setting ‘hidden=True’ when creating the instance. This will hide the property from the web log and CLI getInputs calls.
Each VisDependentProperty has a set of values it considers equivalent to null. When the user sets the VDP value to one of these null values, the VDP machinery converts this to a private NullObject marker that signifies the property is now unset, resulting in the default value being returned next time the property is read. Developers can specify which values should be converted to NullObject by specifying null_input at creation time, e.g.,
solint = @VisDependentProperty(default=5, null_input=[None, ‘’, ‘RESET’, -1])
-
calamptable
¶ VisDependentProperty is a Python data descriptor that standardises the behaviour of pipeline Inputs properties and lets them create default values more easily.
On reading a VisDependentProperty (ie. using the dot prefix: inputs.solint), one of two things happens:
If a NullMarker is found - signifying that no user input has been provided - and a ‘getter’ function has been defined, the getter function will be called to provide a default value for that measurement set.
If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.
The value, either the default from step 1 or user-provided from step 2, is run through the optional postprocess function, which gives a final opportunity to change the value depending on the state/value of other properties.
A VisDependentProperty can be made read-only by specifying ‘readonly=True’ when creating the instance.
A VisDependentProperty can be hidden from the containing Inputs string representation by setting ‘hidden=True’ when creating the instance. This will hide the property from the web log and CLI getInputs calls.
Each VisDependentProperty has a set of values it considers equivalent to null. When the user sets the VDP value to one of these null values, the VDP machinery converts this to a private NullObject marker that signifies the property is now unset, resulting in the default value being returned next time the property is read. Developers can specify which values should be converted to NullObject by specifying null_input at creation time, e.g.,
solint = @VisDependentProperty(default=5, null_input=[None, ‘’, ‘RESET’, -1])
-
calminsnr
¶ VisDependentProperty is a Python data descriptor that standardises the behaviour of pipeline Inputs properties and lets them create default values more easily.
On reading a VisDependentProperty (ie. using the dot prefix: inputs.solint), one of two things happens:
If a NullMarker is found - signifying that no user input has been provided - and a ‘getter’ function has been defined, the getter function will be called to provide a default value for that measurement set.
If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.
The value, either the default from step 1 or user-provided from step 2, is run through the optional postprocess function, which gives a final opportunity to change the value depending on the state/value of other properties.
A VisDependentProperty can be made read-only by specifying ‘readonly=True’ when creating the instance.
A VisDependentProperty can be hidden from the containing Inputs string representation by setting ‘hidden=True’ when creating the instance. This will hide the property from the web log and CLI getInputs calls.
Each VisDependentProperty has a set of values it considers equivalent to null. When the user sets the VDP value to one of these null values, the VDP machinery converts this to a private NullObject marker that signifies the property is now unset, resulting in the default value being returned next time the property is read. Developers can specify which values should be converted to NullObject by specifying null_input at creation time, e.g.,
solint = @VisDependentProperty(default=5, null_input=[None, ‘’, ‘RESET’, -1])
-
calphasetable
¶ VisDependentProperty is a Python data descriptor that standardises the behaviour of pipeline Inputs properties and lets them create default values more easily.
On reading a VisDependentProperty (ie. using the dot prefix: inputs.solint), one of two things happens:
If a NullMarker is found - signifying that no user input has been provided - and a ‘getter’ function has been defined, the getter function will be called to provide a default value for that measurement set.
If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.
The value, either the default from step 1 or user-provided from step 2, is run through the optional postprocess function, which gives a final opportunity to change the value depending on the state/value of other properties.
A VisDependentProperty can be made read-only by specifying ‘readonly=True’ when creating the instance.
A VisDependentProperty can be hidden from the containing Inputs string representation by setting ‘hidden=True’ when creating the instance. This will hide the property from the web log and CLI getInputs calls.
Each VisDependentProperty has a set of values it considers equivalent to null. When the user sets the VDP value to one of these null values, the VDP machinery converts this to a private NullObject marker that signifies the property is now unset, resulting in the default value being returned next time the property is read. Developers can specify which values should be converted to NullObject by specifying null_input at creation time, e.g.,
solint = @VisDependentProperty(default=5, null_input=[None, ‘’, ‘RESET’, -1])
-
calsolint
¶ VisDependentProperty is a Python data descriptor that standardises the behaviour of pipeline Inputs properties and lets them create default values more easily.
On reading a VisDependentProperty (ie. using the dot prefix: inputs.solint), one of two things happens:
If a NullMarker is found - signifying that no user input has been provided - and a ‘getter’ function has been defined, the getter function will be called to provide a default value for that measurement set.
If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.
The value, either the default from step 1 or user-provided from step 2, is run through the optional postprocess function, which gives a final opportunity to change the value depending on the state/value of other properties.
A VisDependentProperty can be made read-only by specifying ‘readonly=True’ when creating the instance.
A VisDependentProperty can be hidden from the containing Inputs string representation by setting ‘hidden=True’ when creating the instance. This will hide the property from the web log and CLI getInputs calls.
Each VisDependentProperty has a set of values it considers equivalent to null. When the user sets the VDP value to one of these null values, the VDP machinery converts this to a private NullObject marker that signifies the property is now unset, resulting in the default value being returned next time the property is read. Developers can specify which values should be converted to NullObject by specifying null_input at creation time, e.g.,
solint = @VisDependentProperty(default=5, null_input=[None, ‘’, ‘RESET’, -1])
-
intent
¶ VisDependentProperty is a Python data descriptor that standardises the behaviour of pipeline Inputs properties and lets them create default values more easily.
On reading a VisDependentProperty (ie. using the dot prefix: inputs.solint), one of two things happens:
If a NullMarker is found - signifying that no user input has been provided - and a ‘getter’ function has been defined, the getter function will be called to provide a default value for that measurement set.
If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.
The value, either the default from step 1 or user-provided from step 2, is run through the optional postprocess function, which gives a final opportunity to change the value depending on the state/value of other properties.
A VisDependentProperty can be made read-only by specifying ‘readonly=True’ when creating the instance.
A VisDependentProperty can be hidden from the containing Inputs string representation by setting ‘hidden=True’ when creating the instance. This will hide the property from the web log and CLI getInputs calls.
Each VisDependentProperty has a set of values it considers equivalent to null. When the user sets the VDP value to one of these null values, the VDP machinery converts this to a private NullObject marker that signifies the property is now unset, resulting in the default value being returned next time the property is read. Developers can specify which values should be converted to NullObject by specifying null_input at creation time, e.g.,
solint = @VisDependentProperty(default=5, null_input=[None, ‘’, ‘RESET’, -1])
-
offsetstable
¶ VisDependentProperty is a Python data descriptor that standardises the behaviour of pipeline Inputs properties and lets them create default values more easily.
On reading a VisDependentProperty (ie. using the dot prefix: inputs.solint), one of two things happens:
If a NullMarker is found - signifying that no user input has been provided - and a ‘getter’ function has been defined, the getter function will be called to provide a default value for that measurement set.
If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.
The value, either the default from step 1 or user-provided from step 2, is run through the optional postprocess function, which gives a final opportunity to change the value depending on the state/value of other properties.
A VisDependentProperty can be made read-only by specifying ‘readonly=True’ when creating the instance.
A VisDependentProperty can be hidden from the containing Inputs string representation by setting ‘hidden=True’ when creating the instance. This will hide the property from the web log and CLI getInputs calls.
Each VisDependentProperty has a set of values it considers equivalent to null. When the user sets the VDP value to one of these null values, the VDP machinery converts this to a private NullObject marker that signifies the property is now unset, resulting in the default value being returned next time the property is read. Developers can specify which values should be converted to NullObject by specifying null_input at creation time, e.g.,
solint = @VisDependentProperty(default=5, null_input=[None, ‘’, ‘RESET’, -1])
-
targetminsnr
¶ VisDependentProperty is a Python data descriptor that standardises the behaviour of pipeline Inputs properties and lets them create default values more easily.
On reading a VisDependentProperty (ie. using the dot prefix: inputs.solint), one of two things happens:
If a NullMarker is found - signifying that no user input has been provided - and a ‘getter’ function has been defined, the getter function will be called to provide a default value for that measurement set.
If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.
The value, either the default from step 1 or user-provided from step 2, is run through the optional postprocess function, which gives a final opportunity to change the value depending on the state/value of other properties.
A VisDependentProperty can be made read-only by specifying ‘readonly=True’ when creating the instance.
A VisDependentProperty can be hidden from the containing Inputs string representation by setting ‘hidden=True’ when creating the instance. This will hide the property from the web log and CLI getInputs calls.
Each VisDependentProperty has a set of values it considers equivalent to null. When the user sets the VDP value to one of these null values, the VDP machinery converts this to a private NullObject marker that signifies the property is now unset, resulting in the default value being returned next time the property is read. Developers can specify which values should be converted to NullObject by specifying null_input at creation time, e.g.,
solint = @VisDependentProperty(default=5, null_input=[None, ‘’, ‘RESET’, -1])
-
targetphasetable
¶ VisDependentProperty is a Python data descriptor that standardises the behaviour of pipeline Inputs properties and lets them create default values more easily.
On reading a VisDependentProperty (ie. using the dot prefix: inputs.solint), one of two things happens:
If a NullMarker is found - signifying that no user input has been provided - and a ‘getter’ function has been defined, the getter function will be called to provide a default value for that measurement set.
If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.
The value, either the default from step 1 or user-provided from step 2, is run through the optional postprocess function, which gives a final opportunity to change the value depending on the state/value of other properties.
A VisDependentProperty can be made read-only by specifying ‘readonly=True’ when creating the instance.
A VisDependentProperty can be hidden from the containing Inputs string representation by setting ‘hidden=True’ when creating the instance. This will hide the property from the web log and CLI getInputs calls.
Each VisDependentProperty has a set of values it considers equivalent to null. When the user sets the VDP value to one of these null values, the VDP machinery converts this to a private NullObject marker that signifies the property is now unset, resulting in the default value being returned next time the property is read. Developers can specify which values should be converted to NullObject by specifying null_input at creation time, e.g.,
solint = @VisDependentProperty(default=5, null_input=[None, ‘’, ‘RESET’, -1])
-
targetsolint
¶ VisDependentProperty is a Python data descriptor that standardises the behaviour of pipeline Inputs properties and lets them create default values more easily.
On reading a VisDependentProperty (ie. using the dot prefix: inputs.solint), one of two things happens:
If a NullMarker is found - signifying that no user input has been provided - and a ‘getter’ function has been defined, the getter function will be called to provide a default value for that measurement set.
If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.
The value, either the default from step 1 or user-provided from step 2, is run through the optional postprocess function, which gives a final opportunity to change the value depending on the state/value of other properties.
A VisDependentProperty can be made read-only by specifying ‘readonly=True’ when creating the instance.
A VisDependentProperty can be hidden from the containing Inputs string representation by setting ‘hidden=True’ when creating the instance. This will hide the property from the web log and CLI getInputs calls.
Each VisDependentProperty has a set of values it considers equivalent to null. When the user sets the VDP value to one of these null values, the VDP machinery converts this to a private NullObject marker that signifies the property is now unset, resulting in the default value being returned next time the property is read. Developers can specify which values should be converted to NullObject by specifying null_input at creation time, e.g.,
solint = @VisDependentProperty(default=5, null_input=[None, ‘’, ‘RESET’, -1])
-