toolbox_scs.misc.bunch_pattern_external

A collection of wrappers around the the euxfel_bunch_pattern pkg

The euxfel_bunch_pattern package provides generic methods to extract information from the bunch pattern tables. To ease its use from within the toolbox some of its methods are wrapped. Like this they show up in the users namespace in a self-explanatory way.

Module Contents

Functions

is_pulse_at(bpt, loc)	Check for prescence of a pulse at the location provided.
is_sase_3(bpt)	Check for prescence of a SASE3 pulse.
is_sase_1(bpt)	Check for prescence of a SASE1 pulse.
is_ppl(bpt)	Check for prescence of pp-laser pulse.

toolbox_scs.misc.bunch_pattern_external.is_pulse_at(bpt, loc)

Check for prescence of a pulse at the location provided.

Parameters:

• bpt (numpy array, xarray DataArray) – The bunch pattern data.

• loc (str) – The location where to check: {‘sase1’, ‘sase3’, ‘scs_ppl’}

Returns:

boolean – true if a pulse is present at loc.

Return type:

numpy array, xarray DataArray

toolbox_scs.misc.bunch_pattern_external.is_sase_3(bpt)

Check for prescence of a SASE3 pulse.

Parameters:

bpt (numpy array, xarray DataArray) – The bunch pattern data.

Returns:

boolean – true if SASE3 pulse is present.

Return type:

numpy array, xarray DataArray

toolbox_scs.misc.bunch_pattern_external.is_sase_1(bpt)

Check for prescence of a SASE1 pulse.

Parameters:

bpt (numpy array, xarray DataArray) – The bunch pattern data.

Returns:

boolean – true if SASE1 pulse is present.

Return type:

numpy array, xarray DataArray

toolbox_scs.misc.bunch_pattern_external.is_ppl(bpt)

Check for prescence of pp-laser pulse.

Parameters:

bpt (numpy array, xarray DataArray) – The bunch pattern data.

Returns:

boolean – true if pp-laser pulse is present.

Return type:

numpy array, xarray DataArray