Page History
...
######################################################################
[psana]
# MODULES: any modules that produce data to be translated need be loaded
# **BEFORE** Translator.H5Output (such as calibrated data or NDArray's)
# event data added by modules listed after Translator.H5Output is not translated.
modules = Translator.H5Output
files = **TODO: SPECIFY INPUT FILES OR DATA SOURCE HERE**
######################################################################
[Translator.H5Output]
# TODO: enter the full h5 output file name, including the output directory
output_file = output_directory/h5output.h5
# # # # # # # # # # # # # # # # # # # # #
# EPICS FILTERING
# The Translator can store epics pv's in one of two ways, or not at all.
# set store_epics below, to one of the following:
#
# updates_only only stores an epic pv when it has changed. The pv is stored
# # in the current calib cycle. For mutli calib cycle experiments,
# # users may have to look back through several calib cycle's to
# # find the latest value of a pv.
#
# calib_repeat repeat each calib cycle will include the latest value of all the epics
# # pv's. This can make it easier to find pv's for a calib cycle.
# # For experiments with many short calib cycles, it can degrade
## performance of translation and performance when working performance of translation and performance when working with the
# with the
# resulting hdf5 file.
#
# no no epics pv's will not be stored. You may also want to set Epics=exclude
# # (see below) if you do not want the epics configuration data stored
# The default is 'updates_only'
store_epics = updates_only
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# TYPE FILTERING
#
# One can include or exclude a class of Psana types with the following
# options. Only the strings include or exclude are valid for these
# type filtering options.
#
# Note - Epics in the list below refers only to the epicsConfig data
# which is the alias list, not the epics pv's (see store_epics above for those)
AcqTdc = include include # Psana::Acqiris::TdcConfigV1, Psana::Acqiris::TdcDataV1
AcqWaveform = include include # Psana::Acqiris::ConfigV1, Psana::Acqiris::DataDescV1
Alias = includeinclude # Psana::# Psana::Alias::ConfigV1
Andor = include include # Psana::Andor::ConfigV1, Psana::Andor::FrameV1
Control = include include # Psana::ControlData::ConfigV1, Psana::ControlData::ConfigV2, Psana::ControlData::ConfigV3
Cspad = include include # Psana::CsPad::ConfigV1, Psana::CsPad::ConfigV2, Psana::CsPad::ConfigV3, Psana::CsPad::ConfigV4, Psana::CsPad::ConfigV5, Psana::CsPad::DataV1, Psana::CsPad::DataV2
Cspad2x2 = include include # Psana::CsPad2x2::ConfigV1, Psana::CsPad2x2::ConfigV2, Psana::CsPad2x2::ElementV1
DiodeFex = include include # Psana::Lusi::DiodeFexConfigV1, Psana::Lusi::DiodeFexConfigV2, Psana::Lusi::DiodeFexV1
EBeam = includeinclude # # Psana:Psana::Bld::BldDataEBeamV0, Psana::Bld::BldDataEBeamV0, Psana::Bld::BldDataEBeamV1, Psana::Bld::BldDataEBeamV2, Psana::Bld::BldDataEBeamV3, Psana::Bld::BldDataEBeamV4
Encoder = include include # Psana::Encoder::ConfigV1, Psana::Encoder::ConfigV2, Psana::Encoder::DataV1, Psana::Encoder::DataV2
Epics = include include # Psana::Epics::ConfigV1
EpixSamplerEpix = includeinclude # Psana::Epix::ConfigV1, Psana::Epix::ElementV1
EpixSampler = include # Psana::EpixSampler::ConfigV1, Psana::EpixSampler::ElementV1
Evr = include include # Psana::EvrData::ConfigV1, Psana::EvrData::ConfigV2, Psana::EvrData::ConfigV3, Psana::EvrData::ConfigV4, Psana::EvrData::ConfigV5, Psana::EvrData::ConfigV6, Psana::EvrData::ConfigV7, Psana::EvrData::DataV3
EvrIO = includeinclude # # Psana::EvrData::IOConfigV1
Evs = include include # Psana::EvrData::SrcConfigV1
FEEGasDetEnergy = includeinclude # Psana::Bld::BldDataFEEGasDetEnergy
Fccd = include include # Psana::FCCD::FccdConfigV1, Psana::FCCD::FccdConfigV2
Fli = include include # Psana::Fli::ConfigV1, Psana::Fli::FrameV1
Frame = include include # Psana::Camera::FrameV1
FrameFccd = includeinclude # Psana::Camera::# Psana::Camera::FrameFccdConfigV1
FrameFex = include include # Psana::Camera::FrameFexConfigV1
GMD = include include # Psana::Bld::BldDataGMDV0, Psana::Bld::BldDataGMDV1
Gsc16ai = include include # Psana::Gsc16ai::ConfigV1, Psana::Gsc16ai::DataV1
Imp = include include # Psana::Imp::ConfigV1, Psana::Imp::ElementV1
Ipimb = include include # Psana::Ipimb::ConfigV1, Psana::Ipimb::ConfigV2, Psana::Ipimb::DataV1, Psana::Ipimb::DataV2
IpmFex = includeinclude # # Psana::Lusi::IpmFexConfigV1, Psana::Lusi::IpmFexConfigV1, Psana::Lusi::IpmFexConfigV2, Psana::Lusi::IpmFexV1
L3T = include include # Psana::L3T::ConfigV1, Psana::L3T::DataV1
OceanOptics = include include # Psana::OceanOptics::ConfigV1, Psana::OceanOptics::DataV1
Opal1k = include include # Psana::Opal1k::ConfigV1
Orca = include include # Psana::Orca::ConfigV1
PhaseCavity = include include # Psana::Bld::BldDataPhaseCavity
PimImage = includeinclude # Psana::# Psana::Lusi::PimImageConfigV1
Princeton = include include # Psana::Princeton::ConfigV1, Psana::Princeton::ConfigV2, Psana::Princeton::ConfigV3, Psana::Princeton::ConfigV4, Psana::Princeton::ConfigV5, Psana::Princeton::FrameV1, Psana::Princeton::FrameV2
PrincetonInfo = include include # Psana::Princeton::InfoV1
Quartz = include include # Psana::Quartz::ConfigV1
Rayonix = include include # Psana::Rayonix::ConfigV1, Psana::Rayonix::ConfigV2
SharedAcqADC = include include # Psana::Bld::BldDataAcqADCV1
SharedIpimb = include include # Psana::Bld::BldDataIpimbV0, Psana::Bld::BldDataIpimbV1
SharedPim = include include # Psana::Bld::BldDataPimV1
Spectrometer = includeinclude # Psana:# Psana::Bld::BldDataSpectrometerV0
TM6740 = include include # Psana::Pulnix::TM6740ConfigV1, Psana::Pulnix::TM6740ConfigV2
Timepix = include include # Psana::Timepix::ConfigV1, Psana::Timepix::ConfigV2, Psana::Timepix::ConfigV3, Psana::Timepix::DataV1, Psana::Timepix::DataV2
TwoDGaussian = include include # Psana::Camera::TwoDGaussianV1
UsdUsb = include include # Psana::UsdUsb::ConfigV1, Psana::UsdUsb::DataV1
pnCCD = include include # Psana::PNCCD::ConfigV1, Psana::PNCCD::ConfigV2, Psana::PNCCD::FramesV1
# user types to translate from the event store
ndarray_types = include include # ndarray<int8_t,1>, ndarray<int8_t,2>, ndarray<int8_t,3>, ndarray<int8_t,4>, ndarray<int16_t,1>, ndarray<int16_t,2>, ndarray<int16_t,3>, ndarray<int16_t,4>, ndarray<int32_t,1>, ndarray<int32_t,2>, ndarray<int32_t,3>, ndarray<int32_t,4>, ndarray<int64_t,1>, ndarray<int64_t,2>, ndarray<int64_t,3>, ndarray<int64_t,4>, ndarray<uint8_t,1>, ndarray<uint8_t,2>, ndarray<uint8_t,3>, ndarray<uint8_t,4>, ndarray<uint16_t,1>, ndarray<uint16_t,2>, ndarray<uint16_t,3>, ndarray<uint16_t,4>, ndarray<uint32_t,1>, ndarray<uint32_t,2>, ndarray<uint32_t,3>, ndarray<uint32_t,4>, ndarray<uint64_t,1>, ndarray<uint64_t,2>, ndarray<uint64_t,3>, ndarray<uint64_t,4>, ndarray<float,1>, ndarray<float,2>, ndarray<float,3>, ndarray<float,4>, ndarray<double,1>, ndarray<double,2>, ndarray<double,3>, ndarray<double,4>
std_string = include include # std::string
# # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# SOURCE FILTERING
#
# The default for the src_filter option is "include all"
# If you want to include a subset of the sources, do
#
# src_filter include srcname1 srcname2
#
# # or if you want to exclude a subset of sources, do
#
# src_filter exclude srcname1 srcname2
#
# The srcname's in xtc input can be printed using the EventKeys
# module.
#
# The syntax for specifying a srcname follows that of the Psana Source.
# The Psana Source syntax allows for several styles for specifying a Pds Src
# as well as detector matches where the detector number, or device number is
# not known.
#
# Specifically, format of the match string can be:
#
# DetInfo(det.detId:dev.devId) - fully or partially specified DetInfo
# det.detId:dev.devId - same as above
# DetInfo(det-detId|dev.devId) - same as above
# det-detId|dev.devId - same as above
# BldInfo(type) - fully or partially specified BldInfo
# type - same as above
# ProcInfo(ipAddr) - fully or partially specified ProcInfo
#
# For example
# DetInfo(AmoETOF.0.Acqiris.0)
# DetInfo(AmoETOF.0.Acqiris)
# DetInfo(AmoETOF:Acqiris)
# AmoETOF:Acqiris
# AmoETOF|Acqiris
#
# will all match the same data, AmoETOF.0.Acqiris.0. The later ones will match
# additional data (such as detector 1, 2, etc.) if it is present.
#
# A simple way to set up src filtering is to take a look at the sources in the
# xtc input using the psana EventKeys module. For example
#
# psana -n 5 -m EventKeys exp=cxi1235:run=33
#
# Will print the EventKeys in the first 5 events. If the output includes
#
# # EventKey(type=Psana::EvrData::DataV3, src=DetInfo(NoDetector.0:Evr.2))
# # EventKey(type=Psana::CsPad::DataV2, src=DetInfo(CxiDs1.0:Cspad.0))
## EventKey(type=Psana::CsPad2x2::ElementV1, src=DetInfo(CxiSc2.0:Cspad2x2.1))
## EventKey(type=Psana::Bld::BldDataEBeamV3, src=BldInfo(EBeam))
## EventKey(type=Psana::Bld::BldDataFEEGasDetEnergy, src=BldInfo(FEEGasDetEnergy))
# # EventKey(type=Psana::Camera::FrameV1, src=BldInfo(CxiDg2_Pim))
#
# Then one can filter on these six srcname's:
#
## NoDetector.0:Evr.2 2 CxiDs1.0:Cspad.00 CxiSc2.0:Cspad2x2.11 EBeam EBeamFEEGasDetEnergy FEEGasDetEnergy CxiDg2_Pim
#
src_filter = include all
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# CALIBRATION FILTERING
#
# Psana calibration modules can produce a calibrated version of CsPad data
# (The data types CsPad::DataV1 or CsPad::DataV2). The module output will be
# data of the same type and src as the uncalibrated data, with an additional key,
# such as 'calibrated'.
#
# The Translator defaults to skipping the translation of the uncalibrated
# data when a calibrated version of that data is present. Below you
# can control the calibration key and whether or not to include the
# uncalibrated data.
calibration_key = calibrated
include_uncalibrated_data = false
# Note: this only affects calibrated data of the same type and src as the
# uncalibrated data. When the calibration module produces a NDArray, both
# the NDArray and the uncalibrated data are translated. If you do not wish
# to translate the uncalibrated data, use appropriate type or src_filter options.
# Likewise if you do not want to translate certain NDArray's, see the
# ndarray_key_filter options below.
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# NDARRAY AND STD::STRING KEY FILTERING
#
# A number of NDArray's and any std::string found in the event store are translated into
# the hdf5 file. NDarray's up to 4 dimensions of 10 basic types (8, 16, 32 and 64 bit
# signed and unsigned int, float and double) are translated, but see the comment after the
# ndarray_types option in the type filtering section for the most up to date list.
#
# These NDArray's and std::string's can be filtered by specifying the eventKey key that was
# used to put the data in the event. While a srcname and key uniquely distinguish data in the
# event store, the Translator filter's NDArray's and std::string's using only the
# key string. The default is to include all ndarray's and std::string's found:
ndarray_key_filter = include all
std_string_key_filter = include all
# an example of including only one ndarray (with keystring being 'finalanswer') would be
#
# ndarray_key_filter include finalanswer
#
# and several ndarrays or strings can be included or excluded
#
# ndarray_key_filter = exclude arrayA arrayB
# std_string_key_filter = include message1 eventDescription
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# COMPRESSION
#
# The following options control compression for most all datasets.
# Shuffling improves compression for certain datasets. Valid values for
# deflate (gzip compression level) are 0-9. Setting deflate = -1 turns off
# compression.
shuffle = true
deflate = 1
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
# TECHNICAL, ADVANCED CONFIGURATION
#
# ---------------------------------------
# CHUNKING
# The commented options below give the default chunking options.
# Objects per chunk are selected from the target chunk size (16 MB) and
# adjusted based on min/max objects per chunk, and the max bytes per chunk.
# It is important that the chunkCache (created on a per dataset basis) be
# large enough to hold at least one chunk, ideally all chunks we need to have
# open at one time when writing to the dataset (usually one, unless we repair
# split events):
# chunkSizeTargetInBytes = 1703936 (16MB)
# chunkSizeTargetObjects = 0 (0 means select objects per chunk from chunkSizeInBytes)
# maxChunkSizeInBytes = 10649600 10649600 (100MB)
# minObjectsPerChunk = 50 50
# maxObjectsPerChunk = 2048
# chunkCacheSizeTargetInChunks = 3
# maxChunkCacheSizeInBytes = 1064960010649600 (100MB)
# ---------------------------------------
# REFINED DATASET CONTROL
#
# There are six classes of datasets for which individual options for shuffle,
# deflate, chunkSizeTargetInBytes and chunkSizeTargetObjects can be specified:
#
# regular (most everything, all psana types)
# epics (all the epics pv's)
# damage (accompanies all regular data from event store)
# ndarrays (new data from other modules)
# string's (new data from other modules)
# eventId (the time dataset that also accompanies all regular data, epics pvs, ndarrays and strings)
#
# The options for regular datasets have been discussed above. The other five datasets
# get their default values for shuffle, deflate, chunkSizeInBytes and chunkSizeInObjects
# from the regular dataset options except in the cases below:
# damageShuffle = false
# stringShuffle = false
# epicsPvShuffle = false
# stringDeflate = -1
# eventIdChunkSizeTargetInBytes = 16384
# epicsPvChunkSizeTargetInBytes = 16384
# The rest of the shuffle, deflate and chunk size options for the other five datasets are:
#
# eventIdShuffle = true
# eventIdDeflate = 1
# damageDeflate = 1
# epicsPvDeflate = 1
# ndarrayShuffle = true
# ndarrayDeflate = 1
# eventIdChunkSizeTargetObjects = 0
# damageChunkSizeTargetInBytes = 1703936
# damageChunkSizeTargetObjects = 0
# stringChunkSizeTargetInBytes = 1703936
# stringChunkSizeTargetObjects = 0
# ndarrayChunkSizeTargetInBytes = 1703936
# ndarrayChunkSizeTargetObjects = 0
# epicsPvChunkSizeTargetObjects = 0
# ---------------------------------------
# SPLIT EVENTS
# When the Translator encounters a split event, it checks a cache to see
# if it has already seen it. If it has, it fills in any blanks that it can.
# To prevent this cache from growing to large, set the maximum number of
# split events to look back through here (default is 3000):
max_saved_split_events = 3000
# ---------------------------------------
# HDF5 GROUP NAMES
# The typenames for beam line data defaults to being written as (for example)
# Bld::BldDataEBeamV0. Setting short_bld_name to true causes it to be
# written as BldDataEBeamV0. If set to true, names are written differently
# then with o2o-translate and the change may break code that reads h5 files
# (such as psana)
short_bld_name = false
# ---------------------------------------
# HDF5 FILE PROPERTIES
#
# split large files, presently we only support NoSplit. Future options may be: Family and SplitScan
# for future splitting, splitSize defaults to 10 GB
split = NoSplit
splitSize = 10737418240
Translation and Damage
psana has a specific damage policy that tells it what damaged data is acceptable for psana modules and what data is not. The default behavior is
...
Overview
Content Tools