G4TrajectoryEncounteredVolumeFilter Class Reference

#include <G4TrajectoryEncounteredVolumeFilter.hh>

Inheritance diagram for G4TrajectoryEncounteredVolumeFilter:

Public Types
typedef G4VTrajectory	Type

Public Member Functions
G4bool	Accept (const G4VTrajectory &) const
void	Add (const G4String &volume)
virtual void	Clear ()
virtual bool	Evaluate (const G4VTrajectory &) const
	G4TrajectoryEncounteredVolumeFilter (const G4String &name="Unspecified")
G4bool	GetActive () const
G4bool	GetInvert () const
G4String	GetName () const
G4bool	GetVerbose () const
G4String	Name () const
virtual void	Print (std::ostream &ostr) const
virtual void	PrintAll (std::ostream &ostr) const
virtual void	Reset ()
void	SetActive (const G4bool &)
void	SetInvert (const G4bool &)
void	SetVerbose (const G4bool &)
virtual	~G4TrajectoryEncounteredVolumeFilter ()

Private Attributes
G4bool	fActive
G4bool	fInvert
G4String	fName
size_t	fNPassed
size_t	fNProcessed
G4bool	fVerbose
std::vector< G4String >	fVolumes

Detailed Description

Definition at line 39 of file G4TrajectoryEncounteredVolumeFilter.hh.

Member Typedef Documentation

Type

typedef G4VTrajectory G4VFilter< G4VTrajectory >::Type

inherited

Definition at line 43 of file G4VFilter.hh.

Constructor & Destructor Documentation

G4TrajectoryEncounteredVolumeFilter()

G4TrajectoryEncounteredVolumeFilter::G4TrajectoryEncounteredVolumeFilter

(

const G4String &

name = "Unspecified"

)

Definition at line 38 of file G4TrajectoryEncounteredVolumeFilter.cc.

  :G4SmartFilter<G4VTrajectory>(name)
{}

~G4TrajectoryEncounteredVolumeFilter()

G4TrajectoryEncounteredVolumeFilter::~G4TrajectoryEncounteredVolumeFilter ( )

virtual

Definition at line 42 of file G4TrajectoryEncounteredVolumeFilter.cc.

{}

Member Function Documentation

Accept()

G4bool G4SmartFilter< G4VTrajectory >::Accept ( const G4VTrajectory &  object ) const

virtualinherited

Implements G4VFilter< G4VTrajectory >.

Definition at line 57 of file G4SmartFilter.hh.

{
  if (fVerbose) {
    G4cout<<"Begin verbose printout for filter "<<G4VFilter<T>::Name()<<G4endl;
    G4cout<<"Active ? :   "<<fActive<<G4endl;
  }
  
  fNProcessed++;
  
  // Pass everything if filter is not active
  if (!fActive) {
    fNPassed++;
    return true;
  }
  
  // Do filtering
  G4bool passed = Evaluate(object);
  
  // Apply inversion if applicable
  if (fInvert) passed = !passed;
  
  if (passed) fNPassed++;
  
  if (fVerbose) {
    G4cout<<"Inverted ? : "<<fInvert<<G4endl;
    G4cout<<"Passed ?   : "<<passed<<G4endl;
    G4cout<<"End verbose printout for filter "<<G4VFilter<T>::Name()<<G4endl;
  }
  
  return passed;
}

Add()

void G4TrajectoryEncounteredVolumeFilter::Add

(

const G4String &

volume

)

Definition at line 82 of file G4TrajectoryEncounteredVolumeFilter.cc.

{
  fVolumes.push_back(volume);
}

References fVolumes.

Clear()

void G4TrajectoryEncounteredVolumeFilter::Clear ( )

virtual

Implements G4SmartFilter< G4VTrajectory >.

Definition at line 100 of file G4TrajectoryEncounteredVolumeFilter.cc.

{
  // Clear volume vector
  fVolumes.clear();
}

References fVolumes.

Evaluate()

bool G4TrajectoryEncounteredVolumeFilter::Evaluate ( const G4VTrajectory &  traj ) const

virtual

Implements G4SmartFilter< G4VTrajectory >.

Definition at line 45 of file G4TrajectoryEncounteredVolumeFilter.cc.

{
  try
  {
    const G4RichTrajectory& richTrajectory = dynamic_cast<const G4RichTrajectory&>(traj);
 
    for (const auto& pvname: fVolumes) {
      for (G4int iPoint = 0; iPoint < richTrajectory.GetPointEntries(); iPoint++) {
        G4VTrajectoryPoint* point = richTrajectory.GetPoint(iPoint);
        if (!point) continue;
        std::vector<G4AttValue>* attValues = point->CreateAttValues();
        std::vector<G4AttValue>::const_iterator iAtt;
        for (iAtt = attValues->begin(); iAtt != attValues->end(); ++iAtt) {
          if (iAtt->GetName() == "PostVPath" &&
              G4StrUtil::contains(iAtt->GetValue(),pvname)) break;
        }
        if (iAtt != attValues->end()) {  // Required value found
          return true;  // First found pvname determines selection.
        }
      }
    }
    return false;
  }
 
  catch (const std::bad_cast&)
  {
    G4ExceptionDescription ed;
    ed << "Requires G4RichTrajectory - \"/vis/scene/add/trajectories rich\"";
    G4Exception
    ("G4TrajectoryEncounteredVolumeFilter::Evaluate(const G4VTrajectory& traj)",
     "modeling0126",
     JustWarning, ed);
    return false;
  }
}

References G4StrUtil::contains(), G4VTrajectoryPoint::CreateAttValues(), fVolumes, G4Exception(), G4RichTrajectory::GetPoint(), G4RichTrajectory::GetPointEntries(), and JustWarning.

GetActive()

G4bool G4SmartFilter< G4VTrajectory >::GetActive

inherited

Definition at line 67 of file G4SmartFilter.hh.

{
  return fActive;
}

GetInvert()

G4bool G4SmartFilter< G4VTrajectory >::GetInvert

inherited

Definition at line 71 of file G4SmartFilter.hh.

{
  return fInvert;
}

GetName()

G4String G4VFilter< G4VTrajectory >::GetName

inherited

Definition at line 61 of file G4VFilter.hh.

{
  return Name();
}

GetVerbose()

G4bool G4SmartFilter< G4VTrajectory >::GetVerbose

inherited

Definition at line 75 of file G4SmartFilter.hh.

{
  return fVerbose;
}

Name()

G4String G4VFilter< G4VTrajectory >::Name

inherited

Definition at line 60 of file G4VFilter.hh.

{
  return fName;
}

Print()

void G4TrajectoryEncounteredVolumeFilter::Print ( std::ostream &  ostr ) const

virtual

Implements G4SmartFilter< G4VTrajectory >.

Definition at line 88 of file G4TrajectoryEncounteredVolumeFilter.cc.

{
  ostr<<"Volume names registered: "<<G4endl;
  std::vector<G4String>::const_iterator iter = fVolumes.begin();
  
  while (iter != fVolumes.end()) {
    ostr<<*iter<<G4endl;    
    iter++;
  }
}

References fVolumes, and G4endl.

PrintAll()

void G4SmartFilter< G4VTrajectory >::PrintAll ( std::ostream &  ostr ) const

virtualinherited

Implements G4VFilter< G4VTrajectory >.

Definition at line 60 of file G4SmartFilter.hh.

{
  ostr<<"Printing data for filter: "<<G4VFilter<T>::Name()<<G4endl;
 
  Print(ostr);
 
  ostr<<"Active ?   : " <<fActive<<G4endl;
  ostr<<"Inverted ? : " <<fInvert<<G4endl;
  ostr<<"#Processed : " <<fNProcessed<<G4endl;
  ostr<<"#Passed    : " <<fNPassed<<G4endl;
}

Reset()

void G4SmartFilter< G4VTrajectory >::Reset

virtualinherited

Implements G4VFilter< G4VTrajectory >.

Definition at line 63 of file G4SmartFilter.hh.

{
  fActive = true;
  fInvert = false;
  fNProcessed = 0;
  fNPassed = 0;
  
  // Clear subclass data
  Clear();
}

SetActive()

void G4SmartFilter< G4VTrajectory >::SetActive ( const G4bool &  active )

inherited

Definition at line 66 of file G4SmartFilter.hh.

{
  fActive = active;
}

SetInvert()

void G4SmartFilter< G4VTrajectory >::SetInvert ( const G4bool &  invert )

inherited

Definition at line 70 of file G4SmartFilter.hh.

{
  fInvert = invert;
}

SetVerbose()

void G4SmartFilter< G4VTrajectory >::SetVerbose ( const G4bool &  verbose )

inherited

Definition at line 74 of file G4SmartFilter.hh.

{
  fVerbose = verbose;
}

Field Documentation

fActive

G4bool G4SmartFilter< G4VTrajectory >::fActive

privateinherited

Definition at line 81 of file G4SmartFilter.hh.

fInvert

G4bool G4SmartFilter< G4VTrajectory >::fInvert

privateinherited

Definition at line 82 of file G4SmartFilter.hh.

fName

G4String G4VFilter< G4VTrajectory >::fName

privateinherited

Definition at line 66 of file G4VFilter.hh.

fNPassed

size_t G4SmartFilter< G4VTrajectory >::fNPassed

mutableprivateinherited

Definition at line 84 of file G4SmartFilter.hh.

fNProcessed

size_t G4SmartFilter< G4VTrajectory >::fNProcessed

mutableprivateinherited

Definition at line 85 of file G4SmartFilter.hh.

fVerbose

G4bool G4SmartFilter< G4VTrajectory >::fVerbose

privateinherited

Definition at line 83 of file G4SmartFilter.hh.

fVolumes

std::vector<G4String> G4TrajectoryEncounteredVolumeFilter::fVolumes

private

Definition at line 63 of file G4TrajectoryEncounteredVolumeFilter.hh.

Referenced by Add(), Clear(), Evaluate(), and Print().

---

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

• source/visualization/modeling/include/G4TrajectoryEncounteredVolumeFilter.hh
• source/visualization/modeling/src/G4TrajectoryEncounteredVolumeFilter.cc