nectarchain.makers.calibration.gain.flatfield_spe_makers.FlatFieldSPEHHVNectarCAMCalibrationTool#

class FlatFieldSPEHHVNectarCAMCalibrationTool(*args, **kwargs)[source]#

Bases: FlatFieldSPENominalNectarCAMCalibrationTool

This method is used to pass to the current instance of Tool the traits defined in the components provided in the componentsList trait. WARNING : This method is maybe not the best way to do it, need to discuss with ctapipe developers.

Methods

add_component

constructs and adds a component to the list of registered components, so that later we can ask for the current configuration of all instances, e.g. in`get_full_config()`.

add_traits

Dynamically add trait attributes to the HasTraits instance.

check_output

Test if output files exist and if they do, throw an error unless self.overwrite is set to True.

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.

clear_instance

unset _instance for this class and singleton parents.

close_handlers

document_config_options

Generate rST format documentation for the config options this application

emit_alias_help

Yield the lines for alias part of the help.

emit_description

Yield lines with the application description.

emit_examples

Yield lines with the usage and examples.

emit_flag_help

Yield the lines for the flag part of the help.

emit_help

Yield the help-lines for each Configurable class in self.classes.

emit_help_epilogue

Yield the very bottom lines of the help message.

emit_options_help

Yield the lines for the options part of the help.

emit_subcommands_help

Yield the lines for the subcommand part of the help.

enter_context

Add a new context manager to the ExitStack of this Tool

exit

finish

flatten_flags

Flatten flags and aliases for loaders, so cl-args override as expected.

generate_config_file

generate default config file from Configurables

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

get_default_logging_config

Return the base logging 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.

initialize

Handle config and any other low-level setup.

initialize_subcommand

Initialize a subcommand with argv.

initialized

Has an instance been created?

instance

Returns a global instance of this class.

launch_instance

Launch a global instance of this Application

load_config_environ

Load config files by environment.

load_config_file

Load a configuration file in one of the supported formats, and merge it with the current config if it exists.

load_run

Static method to load from $NECTARCAMDATA directory data for specified run with max_events.

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.

parse_command_line

Parse the command line arguments.

print_alias_help

Print the alias parts of the help.

print_description

Print the application description.

print_examples

Print usage and examples (see emit_examples()).

print_flag_help

Print the flag part of the help.

print_help

Print the help for each Configurable class in self.classes.

print_options

Print the options part of the help.

print_subcommands

Print the subcommand part of the help.

print_version

Print the version string.

run

Run the tool.

section_names

return section names as a list

set_trait

Forcibly sets trait attribute, including read-only attributes.

setup

setup_instance

split_run

Method to decide if criteria to end a run slice are met

start

start_show_config

start function used when show_config is True

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

update_logging_config

Update the configuration of loggers.

write_provenance

Attributes

aliases

argv

An instance of a Python list.

classes

cli_config

The subset of our configuration that came from the command-line

componentsList

List of Component names to be apply, the order will be respected.

config

A trait whose value must be an instance of a specified class.

config_files

List of configuration files with parameters to load in addition to command-line parameters.

cross_validation_lock

A contextmanager for running a block with our cross validation lock set to True.

description

event_source

Getter method for the _event_source attribute.

events_per_slice

number of events that will be treat before to pull the buffer and writeto disk, if None, all the events will be loaded

examples

extra_args

An instance of a Python list.

flags

keyvalue_description

A trait for unicode strings.

loaded_config_files

Currently loaded configuration files

log

Logger or LoggerAdapter instance

log_config

An instance of a Python dict.

log_datefmt

The date format used by logging formatters for %(asctime)s

log_file

Filename for the log

log_file_level

Logging Level for File Logging

log_format

The Logging format template

log_level

Set the log level by value or name.

logging_config

Configure additional log handlers.

max_events

maximum number of events to be loaded

name

npixels

Getter method for the npixels attribute.

option_description

A trait for unicode strings.

output_path

output filename

overwrite

A boolean (True, False) trait.

parent

A trait whose value must be an instance of a specified class.

pixels_id

the list of pixel id to apply the components

progress_bar

show progress bar during processing

provenance_log

A path Trait for input/output files.

quiet

A boolean (True, False) trait.

raise_config_file_errors

A boolean (True, False) trait.

reload_events

a flag to re compute the charge from raw data

run_file

file name to be loaded

run_number

run number to be treated

show_config

Instead of starting the Application, dump configuration to stdout

show_config_json

Instead of starting the Application, dump configuration to stdout (as JSON)

subapp

A trait whose value must be an instance of a specified class.

subcommand_description

A trait for unicode strings.

subcommands

An instance of a Python dict.

version

A trait for unicode strings.

version_string

a formatted version string with version, release, and git hash

componentsList#

List of Component names to be apply, the order will be respected. Possible values: []