nectarchain.makers.component.core.NectarCAMComponent#
- class NectarCAMComponent(*args: t.Any, **kwargs: t.Any)[source]#
Bases:
TelescopeComponentThe base class for NectarCAM components.
Initializes the NectarCAMComponent.
- Parameters:
- subarrayctapipe.core.SubarrayDescription
The subarray description. Must contain exactly one telescope.
- configctapipe.core.Config, optional
Configuration object.
- parentComponent, optional
Parent component.
- *args
Additional positional arguments forwarded to TelescopeComponent.
- **kwargs
Additional keyword arguments forwarded to TelescopeComponent.
- Raises:
- ValueError
If the subarray contains more than one telescope.
Methods
add_traitsDynamically add trait attributes to the HasTraits instance.
class_config_rst_docGenerate rST documentation for this class' config options.
class_config_sectionGet the config section for this class.
class_get_helpGet the help string for this class in ReST format.
class_get_trait_helpGet the helptext string for a single trait.
class_own_trait_eventsGet a dict of all event handlers defined on this class, not a parent.
class_own_traitsGet a dict of all the traitlets defined on this class, not a parent.
class_print_helpGet the help string for a single trait and print it.
class_trait_namesGet a list of all the names of this class' traits.
class_traitsGet a
dictof all the traits of this class.from_nameObtain an instance of a subclass via its name
get_current_configreturn the current configuration as a dict (e.g. the values of all traits, even if they were not set during configuration).
has_traitReturns True if the object has a trait with the specified name.
hold_trait_notificationsContext manager for bundling trait change notifications and cross validation.
non_abstract_subclassesGet a dict of all non-abstract subclasses of this class.
notify_changeNotify observers of a change event
observeSetup a handler to be called when a trait changes.
on_trait_changeDEPRECATED: Setup a handler to be called when a trait changes.
section_namesreturn section names as a list
set_traitForcibly sets trait attribute, including read-only attributes.
setup_instancetrait_defaultsReturn a trait's default value or a dictionary of them
trait_eventsGet a
dictof all the event handlers of this class.trait_has_valueReturns True if the specified trait has a value.
trait_metadataGet metadata values for trait by key.
trait_namesGet a list of all the names of this class' traits.
trait_valuesA
dictof trait names and their values.traitsGet a
dictof all the traits of this class.unobserveRemove a trait change handler.
unobserve_allRemove trait change handlers of any type for the specified name.
update_configUpdate config and load the new values
Attributes
List of Component names that are used inside current component, this is used to resolve recursively the configurable traits defined in sub-components.
Returns the camera description.
Returns the camera name.
configA trait whose value must be an instance of a specified class.
cross_validation_lockA contextmanager for running a block with our cross validation lock set to True.
Returns a deep copy of the number of pixels.
parentA trait whose value must be an instance of a specified class.
Returns a deep copy of the pixel IDs array.
Returns a deep copy of the run number.
subarrayReturns the telescope ID.
- SubComponents#
List of Component names that are used inside current component, this is used to resolve recursively the configurable traits defined in sub-components. Possible values: []
- abstractmethod __call__(event: NectarCAMDataContainer, *args, **kwargs)[source]#
Process an event. Must be implemented by subclasses.
- Parameters:
- eventNectarCAMDataContainer
The event to process.
- *args
Additional positional arguments.
- **kwargs
Additional keyword arguments.
- property camera#
Returns the camera description.
- Returns:
- ctapipe.instrument.CameraDescription
A deep copy of the camera description.
- property camera_name#
Returns the camera name.
- Returns:
- str
A deep copy of the camera name.
- property npixels#
Returns a deep copy of the number of pixels.
- Returns:
- int
A deep copy of the number of pixels.
- property pixels_id#
Returns a deep copy of the pixel IDs array.
- Returns:
- np.ndarray
A deep copy of the pixel IDs array.
- property run_number#
Returns a deep copy of the run number.
- Returns:
- int
A deep copy of the run number.
- property tel_id#
Returns the telescope ID.
- Returns:
- int
A deep copy of the telescope ID.