nectarchain.makers.component.flatfield_component.FlatFieldComponent#

class FlatFieldComponent(*args: t.Any, **kwargs: t.Any)[source]#

Bases: NectarCAMComponent

Component that computes flat field coefficients from raw data.

Parameters:

window_shift: int: time in ns before the peak to integrate charge (default value = 5)
window_width: int: duration of the extraction window in ns (default value = 12)
window_pedestal: int: duration of the pedestal estimation time window since the start of the waveform, in ns (default value = 20)
gain: list: array of gain value (default value = array of 58 and 58/13)
bad_pix: list: list of bad pixels (default value = [])
charge_extraction_method: srt: name of the charge extraction method (“LocalPeakWindowSum” or “GlobalPeakWindowSum” ; default value = None)
charge_integration_correction: bool: application of a correction from the charge extractor (default value = False)

Initialize the FlatFieldComponent.

Parameters:

subarrayctapipe.instrument.SubarrayDescription: The subarray description.
configtraitlets.config.loader.Config, optional: Configuration object.
parentobject, optional: Parent component.

Methods

`add_traits`	Dynamically add trait attributes to the HasTraits instance.
`class_config_rst_doc`	Generate rST documentation for this class' config options.
`class_config_section`	Get the config section for this class.
`class_get_help`	Get the help string for this class in ReST format.
`class_get_trait_help`	Get the helptext string for a single trait.
`class_own_trait_events`	Get a dict of all event handlers defined on this class, not a parent.
`class_own_traits`	Get a dict of all the traitlets defined on this class, not a parent.
`class_print_help`	Get the help string for a single trait and print it.
`class_trait_names`	Get a list of all the names of this class' traits.
`class_traits`	Get a `dict` of all the traits of this class.
`finish`	Finalize the flat-field computation.
`from_name`	Obtain an instance of a subclass via its name
`get_current_config`	return the current configuration as a dict (e.g. the values of all traits, even if they were not set during configuration).
`has_trait`	Returns True if the object has a trait with the specified name.
`hold_trait_notifications`	Context manager for bundling trait change notifications and cross validation.
`make_badpix_mask`	Make a boolean mask with the list of bad pixels (used by GlobalPeakWindowSum)
`make_masked_array`	Define an array that will be used as a mask on the waveforms for the calculation of the integrated amplitude of the signal
`non_abstract_subclasses`	Get a dict of all non-abstract subclasses of this class.
`notify_change`	Notify observers of a change event
`observe`	Setup a handler to be called when a trait changes.
`on_trait_change`	DEPRECATED: Setup a handler to be called when a trait changes.
`section_names`	return section names as a list
`set_trait`	Forcibly sets trait attribute, including read-only attributes.
`setup_instance`
`subtract_pedestal_from_container`	Substract the pedestal from a given `NectarCAMPedestalContainer`
`subtract_pedestal_from_first_samples`	Subtract the pedestal defined as the average of the first samples of each trace
`trait_defaults`	Return a trait's default value or a dictionary of them
`trait_events`	Get a `dict` of all the event handlers of this class.
`trait_has_value`	Returns True if the specified trait has a value.
`trait_metadata`	Get metadata values for trait by key.
`trait_names`	Get a list of all the names of this class' traits.
`trait_values`	A `dict` of trait names and their values.
`traits`	Get a `dict` of all the traits of this class.
`unobserve`	Remove a trait change handler.
`unobserve_all`	Remove trait change handlers of any type for the specified name.
`update_config`	Update config and load the new values

Attributes

`SubComponents`	List of Component names that are used inside current component, this is used to resolve recursively the configurable traits defined in sub-components.
`bad_pix`	list of bad pixels
`camera`	Returns the camera description.
`camera_name`	Returns the camera name.
`charge_extraction_method`	name of the charge extraction method
`charge_integration_correction`	correction applied by the charge extractor
`config`	A trait whose value must be an instance of a specified class.
`cross_validation_lock`	A contextmanager for running a block with our cross validation lock set to True.
`gain`	default gain value
`gain_file`	Path to h5 file with gain calibration coefficients
`npixels`	Returns a deep copy of the number of pixels.
`parent`	A trait whose value must be an instance of a specified class.
`pedestal_file`	Path to h5 file with pedestal calibration coefficients
`pixels_id`	Returns a deep copy of the pixel IDs array.
`run_number`	Returns a deep copy of the run number.
`subarray`
`tel_id`	Returns the telescope ID.
`window_pedestal`	the duration of the pedestal estimation window since the start of the waveform in ns
`window_shift`	the time in ns before the peak to integrate charge
`window_width`	the duration of the extraction window in ns

__call__(event: NectarCAMDataContainer, *args, **kwargs)[source]#

Process a flat-field event.

Parameters:

eventNectarCAMDataContainer: The event to process. Only FLATFIELD events are handled.

bad_pix#: list of bad pixels

charge_extraction_method#: name of the charge extraction method

charge_integration_correction#: correction applied by the charge extractor

finish()[source]#

Finalize the flat-field computation.

Returns:

FlatFieldContainer: Container with the flat-field coefficients, event metadata, integrated charges, efficiency coefficients, and bad pixel mask.

gain#: default gain value

gain_file#: Path to h5 file with gain calibration coefficients

static make_badpix_mask(pixels_id, bad_pixel_list)[source]#

Make a boolean mask with the list of bad pixels (used by GlobalPeakWindowSum)

Args:: bad_pixel_list: list of bad pixels
Returns:: badpix_mask: boolean mask

static make_masked_array(t_peak, window_shift, window_width)[source]#

Define an array that will be used as a mask on the waveforms for the calculation of the integrated amplitude of the signal

Args:: t_peak: sample corresponding the the highest peak of the trace window_shift: number of samples before the peak to integrate charge window_width: duration of the extraction window in samples
Returns:: masked_wfs: a mask array

pedestal_file#: Path to h5 file with pedestal calibration coefficients

subtract_pedestal_from_container(wfs)[source]#

Substract the pedestal from a given NectarCAMPedestalContainer

Args:: wfs: raw waveforms
Returns:: wfs_pedsub: waveforms substracted from the pedestal

static subtract_pedestal_from_first_samples(wfs, window=20)[source]#

Subtract the pedestal defined as the average of the first samples of each trace

Args:: wfs: raw wavefroms window: number of samples n to calculate the pedestal (default value is 20)
Returns:: wfs_pedsub: wavefroms subtracted from the pedestal

window_pedestal#: the duration of the pedestal estimation window since the start of the waveform in ns

window_shift#: the time in ns before the peak to integrate charge

window_width#: the duration of the extraction window in ns