pipeline.hifv.tasks.flagging package

Submodules

pipeline.hifv.tasks.flagging.checkflag module

class pipeline.hifv.tasks.flagging.checkflag.Checkflag(inputs)

Bases: pipeline.infrastructure.basetask.StandardTaskTemplate

Inputs

alias of CheckflagInputs

analyse(results)

Determine the best parameters by analysing the given jobs before returning any final jobs to execute.

Parameters

jobs (a list ofJobRequest) – the job requests generated by prepare()

Return type

Result

do_allcalsvlass()

do_bpdvlass()

do_targetvlass()

prepare()

Prepare job requests for execution.

Parameters

parameters – the parameters to pass through to the subclass. Refer to the implementing subclass for specific information on what these parameters are.

Return type

a class implementing Result

thresholds(inputThresholds)

vla_basebands(science_windows_only=True)

class pipeline.hifv.tasks.flagging.checkflag.CheckflagInputs(context, vis=None, checkflagmode=None, overwrite_modelcol=None)

Bases: pipeline.infrastructure.vdp.StandardInputs

checkflagmode

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:

1. 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.

2. If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.

3. 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])

overwrite_modelcol

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:

1. 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.

2. If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.

3. 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])

class pipeline.hifv.tasks.flagging.checkflag.CheckflagResults(jobs=None, summary_stats=None)

Bases: pipeline.infrastructure.basetask.Results

pipeline.hifv.tasks.flagging.displaycheckflag module

class pipeline.hifv.tasks.flagging.displaycheckflag.checkflagSummaryChart(context, result)

Bases: object

create_plot(prefix)

get_figfile(prefix)

get_plot_wrapper(prefix)

plot()

pipeline.hifv.tasks.flagging.flagbaddeformatters module

class pipeline.hifv.tasks.flagging.flagbaddeformatters.FlagBadDeformatters(inputs)

Bases: pipeline.infrastructure.basetask.StandardTaskTemplate

Inputs

alias of FlagBadDeformattersInputs

analyse(results)

Determine the best parameters by analysing the given jobs before returning any final jobs to execute.

Parameters

jobs (a list ofJobRequest) – the job requests generated by prepare()

Return type

Result

prepare()

Prepare job requests for execution.

Parameters

parameters – the parameters to pass through to the subclass. Refer to the implementing subclass for specific information on what these parameters are.

Return type

a class implementing Result

class pipeline.hifv.tasks.flagging.flagbaddeformatters.FlagBadDeformattersInputs(context, vis=None, doflagundernspwlimit=None)

Bases: pipeline.infrastructure.vdp.StandardInputs

doflagundernspwlimit

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:

1. 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.

2. If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.

3. 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])

class pipeline.hifv.tasks.flagging.flagbaddeformatters.FlagBadDeformattersResults(jobs=None, result_amp=None, result_phase=None, amp_collection=None, phase_collection=None, num_antennas=None)

Bases: pipeline.infrastructure.basetask.Results

pipeline.hifv.tasks.flagging.flagcal module

class pipeline.hifv.tasks.flagging.flagcal.Flagcal(inputs)

Bases: pipeline.infrastructure.basetask.StandardTaskTemplate

Inputs

alias of FlagcalInputs

analyse(results)

Determine the best parameters by analysing the given jobs before returning any final jobs to execute.

Parameters

jobs (a list ofJobRequest) – the job requests generated by prepare()

Return type

Result

prepare()

Prepare job requests for execution.

Parameters

parameters – the parameters to pass through to the subclass. Refer to the implementing subclass for specific information on what these parameters are.

Return type

a class implementing Result

class pipeline.hifv.tasks.flagging.flagcal.FlagcalInputs(context, vis=None, caltable=None, clipminmax=None)

Bases: pipeline.infrastructure.vdp.StandardInputs

caltable

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:

1. 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.

2. If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.

3. 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])

clipminmax

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:

1. 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.

2. If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.

3. 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])

class pipeline.hifv.tasks.flagging.flagcal.FlagcalResults(final=[], pool=[], preceding=[])

Bases: pipeline.infrastructure.basetask.Results

merge_with_context(context)

See :method:`~pipeline.infrastructure.api.Results.merge_with_context`

pipeline.hifv.tasks.flagging.flagdetervla module

class pipeline.hifv.tasks.flagging.flagdetervla.FlagDeterVLA(inputs)

Bases: pipeline.h.tasks.flagging.flagdeterbase.FlagDeterBase

Inputs

alias of FlagDeterVLAInputs

prepare()

Prepare and execute a flagdata flagging job appropriate to the task inputs.

This method generates, overwriting if necessary, an ASCII file containing flagdata flagging commands. A flagdata task is then executed, using this ASCII file as inputs.

verify_spw(spw)

Verify that the given spw should be flagged, raising a ValueError if it should not.

Checks in this function should be generic. Observatory-dependent tests should be added by extending FlagDeterBase and overriding this method.

class pipeline.hifv.tasks.flagging.flagdetervla.FlagDeterVLAInputs(context, vis=None, output_dir=None, flagbackup=None, autocorr=None, shadow=None, scan=None, scannumber=None, quack=None, clip=None, baseband=None, intents=None, edgespw=None, fracspw=None, fracspwfps=None, online=None, fileonline=None, template=None, filetemplate=None, hm_tbuff=None, tbuff=None)

Bases: pipeline.h.tasks.flagging.flagdeterbase.FlagDeterBaseInputs

FlagDeterVLAInputs defines the inputs for the FlagDeterVLA pipeline task.

baseband

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:

1. 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.

2. If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.

3. 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])

clip

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:

1. 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.

2. If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.

3. 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])

edgespw

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:

1. 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.

2. If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.

3. 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])

fracspw

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:

1. 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.

2. If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.

3. 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])

intents

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:

1. 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.

2. If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.

3. 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])

quack

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:

1. 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.

2. If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.

3. 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])

template

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:

1. 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.

2. If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.

3. 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])

to_casa_args()

Translate the input parameters of this class to task parameters required by the CASA task flagdata. The returned object is a dictionary of flagdata arguments as keyword/value pairs.

Return type

dict

class pipeline.hifv.tasks.flagging.flagdetervla.FlagDeterVLAResults(summaries, flagcmds)

Bases: pipeline.h.tasks.flagging.flagdeterbase.FlagDeterBaseResults

pipeline.hifv.tasks.flagging.qa module

class pipeline.hifv.tasks.flagging.qa.CheckflagListQAHandler

Bases: pipeline.infrastructure.pipelineqa.QAPlugin

QA handler for a list containing CheckflagResults.

child_cls

alias of pipeline.hifv.tasks.flagging.checkflag.CheckflagResults

generating_task

alias of pipeline.hifv.tasks.flagging.checkflag.Checkflag

handle(context, result)

result_cls

alias of collections.abc.Iterable

class pipeline.hifv.tasks.flagging.qa.CheckflagQAHandler

Bases: pipeline.infrastructure.pipelineqa.QAPlugin

child_cls = None

generating_task

alias of pipeline.hifv.tasks.flagging.checkflag.Checkflag

handle(context, result)

result_cls

alias of pipeline.hifv.tasks.flagging.checkflag.CheckflagResults

class pipeline.hifv.tasks.flagging.qa.FlagBadDeformattersListQAHandler

Bases: pipeline.infrastructure.pipelineqa.QAPlugin

QA handler for a list containing FlagBadDeformattersResults.

child_cls

alias of pipeline.hifv.tasks.flagging.flagbaddeformatters.FlagBadDeformattersResults

generating_task

alias of pipeline.hifv.tasks.flagging.flagbaddeformatters.FlagBadDeformatters

handle(context, result)

result_cls

alias of collections.abc.Iterable

class pipeline.hifv.tasks.flagging.qa.FlagBadDeformattersQAHandler

Bases: pipeline.infrastructure.pipelineqa.QAPlugin

child_cls = None

generating_task

alias of pipeline.hifv.tasks.flagging.flagbaddeformatters.FlagBadDeformatters

handle(context, result)

result_cls

alias of pipeline.hifv.tasks.flagging.flagbaddeformatters.FlagBadDeformattersResults

class pipeline.hifv.tasks.flagging.qa.FlagdataListQAHandler

Bases: pipeline.infrastructure.pipelineqa.QAPlugin

QA handler for a list containing TargetflagResults.

child_cls

alias of pipeline.hifv.tasks.flagging.targetflag.TargetflagResults

generating_task

alias of pipeline.hifv.tasks.flagging.targetflag.Targetflag

handle(context, result)

result_cls

alias of collections.abc.Iterable

class pipeline.hifv.tasks.flagging.qa.FlagdataQAHandler

Bases: pipeline.infrastructure.pipelineqa.QAPlugin

child_cls = None

generating_task

alias of pipeline.hifv.tasks.flagging.flagdetervla.FlagDeterVLA

handle(context, result)

result_cls

alias of pipeline.hifv.tasks.flagging.flagdetervla.FlagDeterVLAResults

class pipeline.hifv.tasks.flagging.qa.TargetflagListQAHandler

Bases: pipeline.infrastructure.pipelineqa.QAPlugin

QA handler for a list containing TargetflagResults.

child_cls

alias of pipeline.hifv.tasks.flagging.targetflag.TargetflagResults

generating_task

alias of pipeline.hifv.tasks.flagging.targetflag.Targetflag

handle(context, result)

result_cls

alias of collections.abc.Iterable

class pipeline.hifv.tasks.flagging.qa.TargetflagQAHandler

Bases: pipeline.infrastructure.pipelineqa.QAPlugin

child_cls = None

generating_task

alias of pipeline.hifv.tasks.flagging.targetflag.Targetflag

handle(context, result)

result_cls

alias of pipeline.hifv.tasks.flagging.targetflag.TargetflagResults

pipeline.hifv.tasks.flagging.renderer module

pipeline.hifv.tasks.flagging.renderer.FlagTotal

alias of pipeline.hifv.tasks.flagging.renderer.FlagSummary

class pipeline.hifv.tasks.flagging.renderer.T2_4MDetailsFlagDeterVLARenderer(uri='flagdetervla.mako', description='VLA Deterministic flagging', always_rerender=False)

Bases: pipeline.infrastructure.renderer.basetemplates.T2_4MDetailsDefaultRenderer

FlagTotal

alias of FlagSummary

flagplot(result, context)

flags_by_intent(ms, summaries)

flags_by_science_spws(ms, summaries)

flags_for_result(result, context)

get_display_context(context, result)

class pipeline.hifv.tasks.flagging.renderer.T2_4MDetailscheckflagRenderer(uri='checkflag.mako', description='Checkflag summary', always_rerender=False)

Bases: pipeline.infrastructure.renderer.basetemplates.T2_4MDetailsDefaultRenderer

get_display_context(context, results)

class pipeline.hifv.tasks.flagging.renderer.T2_4MDetailstargetflagRenderer(uri='vlatargetflag.mako', description='Targetflag (All targets through RFLAG)', always_rerender=False)

Bases: pipeline.infrastructure.renderer.basetemplates.T2_4MDetailsDefaultRenderer

get_display_context(context, results)

pipeline.hifv.tasks.flagging.targetflag module

class pipeline.hifv.tasks.flagging.targetflag.Targetflag(inputs)

Bases: pipeline.infrastructure.basetask.StandardTaskTemplate

Inputs

alias of TargetflagInputs

analyse(results)

Determine the best parameters by analysing the given jobs before returning any final jobs to execute.

Parameters

jobs (a list ofJobRequest) – the job requests generated by prepare()

Return type

Result

prepare()

Prepare job requests for execution.

Parameters

parameters – the parameters to pass through to the subclass. Refer to the implementing subclass for specific information on what these parameters are.

Return type

a class implementing Result

class pipeline.hifv.tasks.flagging.targetflag.TargetflagInputs(context, vis=None, intents=None)

Bases: pipeline.infrastructure.vdp.StandardInputs

intents

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:

1. 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.

2. If a user has overridden the value (eg. inputs.solint = 123), that value will be retrieved.

3. 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])

class pipeline.hifv.tasks.flagging.targetflag.TargetflagResults(jobs=None, summarydict=None)

Bases: pipeline.infrastructure.basetask.Results

pipeline.hifv.tasks.flagging.targetflagdisplay module

class pipeline.hifv.tasks.flagging.targetflagdisplay.targetflagSummaryChart(context, result)

Bases: object

get_figfile(prefix)

plot()

Module contents