Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Acts::ProtoVolume Struct Reference

#include <acts/blob/sPHENIX/Core/include/Acts/Detector/ProtoDetector.hpp>

+ Collaboration diagram for Acts::ProtoVolume:

Classes

struct  ContainerStructure
 
struct  InternalStructure
 

Public Member Functions

bool operator== (const ProtoVolume &ptVolume) const
 
void harmonize (bool legacy=true)
 
void extendUp (ProtoVolume &ptVolume)
 
void propagateMinDown (BinningValue bValue)
 
void propagateMaxDown (BinningValue bValue)
 
void constrainDown (const ProtoVolume &ptVolume)
 
std::string toString (const std::string &indent="") const
 

Public Attributes

std::string name = ""
 Name of the proto volume.
 
Extent extent
 The extent of this volume.
 
std::optional< InternalStructureinternal = std::nullopt
 Information about internal structure - legacy building.
 
std::optional< ContainerStructurecontainer = std::nullopt
 Information about container structure - legacy building.
 
Experimental::DetectorBlockBuilder blockBuilder
 An attached Detector volume Builder - new detector schema.
 

Detailed Description

A proto volume description being used to define an overall structure of either a TrackingVolume or Experimental::DetectorVolume

Definition at line 49 of file ProtoDetector.hpp.

View newest version in sPHENIX GitHub at line 49 of file ProtoDetector.hpp

Member Function Documentation

void Acts::ProtoVolume::constrainDown ( const ProtoVolume ptVolume)

Constrain the daughter volumes with this volume

Parameters
ptVolumeis the proto volume from which the constrain is taken

Definition at line 45 of file ProtoDetector.cpp.

View newest version in sPHENIX GitHub at line 45 of file ProtoDetector.cpp

References container, and extent.

Referenced by Acts::ProtoDetector::harmonize().

+ Here is the caller graph for this function:

void Acts::ProtoVolume::extendUp ( Acts::ProtoVolume ptVolume)

Extend the tracking volume with its own constituents, upwards here means that extents are promoted to the mother

Parameters
ptVolumethe protoVolume

Definition at line 17 of file ProtoDetector.cpp.

View newest version in sPHENIX GitHub at line 17 of file ProtoDetector.cpp

References container, Acts::Extent::extend(), and extent.

Referenced by Acts::ProtoDetector::harmonize().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void Acts::ProtoVolume::harmonize ( bool  legacy = true)

Harmonize the detector information, this can run in two modes, steered by the

Parameters
legacyboolean

The legacy mode prepares everything for Acts::TrackingVolume, if off it creates a description for Acts::Detector.

Definition at line 54 of file ProtoDetector.cpp.

View newest version in sPHENIX GitHub at line 54 of file ProtoDetector.cpp

References telescope_simulation::binValue, container, extent, BlackHoleGeometry::gap, perf_headwind::name, name, Acts::s_binningValues, Acts::Extent::set(), to_string(), physmon_ckf_tracking::u, and KFPMath::zero().

Referenced by Acts::ProtoDetector::harmonize().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool Acts::ProtoVolume::operator== ( const ProtoVolume ptVolume) const

Define an operator==

Parameters
ptVolumethe proto volume to be checked
void Acts::ProtoVolume::propagateMaxDown ( BinningValue  bValue)

Extend the tracking volume with its own constituents

Parameters
bValuethe binning value that is propagated

Definition at line 36 of file ProtoDetector.cpp.

View newest version in sPHENIX GitHub at line 36 of file ProtoDetector.cpp

References container.

void Acts::ProtoVolume::propagateMinDown ( BinningValue  bValue)

Extend the tracking volume with its own constituents

Parameters
bValuethe binning value that is propagated

Definition at line 27 of file ProtoDetector.cpp.

View newest version in sPHENIX GitHub at line 27 of file ProtoDetector.cpp

References container.

std::string Acts::ProtoVolume::toString ( const std::string &  indent = "") const

Write the tracking volume to screen

Parameters
indentthe current indentation

Definition at line 175 of file ProtoDetector.cpp.

View newest version in sPHENIX GitHub at line 175 of file ProtoDetector.cpp

References Acts::Test::cb, container, and perf_headwind::name.

Member Data Documentation

Experimental::DetectorBlockBuilder Acts::ProtoVolume::blockBuilder

An attached Detector volume Builder - new detector schema.

Definition at line 80 of file ProtoDetector.hpp.

View newest version in sPHENIX GitHub at line 80 of file ProtoDetector.hpp

std::optional<ContainerStructure> Acts::ProtoVolume::container = std::nullopt

Information about container structure - legacy building.

Definition at line 77 of file ProtoDetector.hpp.

View newest version in sPHENIX GitHub at line 77 of file ProtoDetector.hpp

Referenced by Acts::Test::BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), extendUp(), Acts::from_json(), Acts::to_json(), and Acts::KDTreeTrackingGeometryBuilder::translateVolume().

std::optional<InternalStructure> Acts::ProtoVolume::internal = std::nullopt

Information about internal structure - legacy building.

Definition at line 74 of file ProtoDetector.hpp.

View newest version in sPHENIX GitHub at line 74 of file ProtoDetector.hpp

Referenced by Acts::Test::BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), Acts::from_json(), Acts::to_json(), and Acts::KDTreeTrackingGeometryBuilder::translateLayer().


The documentation for this struct was generated from the following files: