G4TrajectoryChargeFilter Class Reference

#include <G4TrajectoryChargeFilter.hh>

Inheritance diagram for G4TrajectoryChargeFilter:

Public Types
typedef G4VTrajectory	Type

Public Member Functions
G4bool	Accept (const G4VTrajectory &) const
void	Add (const G4String &particle)
virtual void	Clear ()
virtual bool	Evaluate (const G4VTrajectory &) const
	G4TrajectoryChargeFilter (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	~G4TrajectoryChargeFilter ()

Private Types
enum	MyCharge { Negative =-1 , Neutral =0 , Positive =1 }

Private Member Functions
void	Add (const MyCharge &chgear)
G4bool	ConvertToCharge (const G4String &, MyCharge &)

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

Detailed Description

Definition at line 39 of file G4TrajectoryChargeFilter.hh.

Member Typedef Documentation

Type

typedef G4VTrajectory G4VFilter< G4VTrajectory >::Type

inherited

Definition at line 43 of file G4VFilter.hh.

Member Enumeration Documentation

MyCharge

enum G4TrajectoryChargeFilter::MyCharge

private

Enumerator
Negative
Neutral
Positive

Definition at line 62 of file G4TrajectoryChargeFilter.hh.

{Negative=-1, Neutral=0, Positive=1}; 

Constructor & Destructor Documentation

G4TrajectoryChargeFilter()

G4TrajectoryChargeFilter::G4TrajectoryChargeFilter

(

const G4String &

name = "Unspecified"

)

Definition at line 35 of file G4TrajectoryChargeFilter.cc.

  :G4SmartFilter<G4VTrajectory>(name)
{}

~G4TrajectoryChargeFilter()

G4TrajectoryChargeFilter::~G4TrajectoryChargeFilter ( )

virtual

Definition at line 39 of file G4TrajectoryChargeFilter.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() [1/2]

void G4TrajectoryChargeFilter::Add

(

const G4String &

particle

)

Definition at line 63 of file G4TrajectoryChargeFilter.cc.

{
  MyCharge myCharge;
  
  if (!ConvertToCharge(charge, myCharge)) {
    G4ExceptionDescription ed;
    ed << "Invalid charge "<<charge;
    G4Exception   
      ("G4TrajectoryChargeFilter::Add(const G4String& charge)",
       "modeling0115", JustWarning, ed);
    return;
  }
  
  return Add(myCharge);
}

References Add(), ConvertToCharge(), G4Exception(), and JustWarning.

Referenced by Add().

Add() [2/2]

void G4TrajectoryChargeFilter::Add ( const MyCharge &  chgear )

private

Definition at line 80 of file G4TrajectoryChargeFilter.cc.

{
  fCharges.push_back(charge);
}

References fCharges.

Clear()

void G4TrajectoryChargeFilter::Clear ( )

virtual

Implements G4SmartFilter< G4VTrajectory >.

Definition at line 98 of file G4TrajectoryChargeFilter.cc.

{
  // Clear registered charge vector
  fCharges.clear();
}

References fCharges.

ConvertToCharge()

G4bool G4TrajectoryChargeFilter::ConvertToCharge ( const G4String &  string, MyCharge &  myCharge  )

private

Definition at line 105 of file G4TrajectoryChargeFilter.cc.

{
  bool result(true);
 
  G4int charge;
  std::istringstream is(string.c_str());
  is >> charge;
 
  switch (charge) {
  case 1:
    myCharge = G4TrajectoryChargeFilter::Positive;
    break;
  case 0:
    myCharge = G4TrajectoryChargeFilter::Neutral;  
    break;
  case -1:
    myCharge = G4TrajectoryChargeFilter::Negative;   
    break;
  default:
    result = false;
  }
  
  return result;
}

References Negative, Neutral, and Positive.

Referenced by Add().

Evaluate()

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

virtual

Implements G4SmartFilter< G4VTrajectory >.

Definition at line 42 of file G4TrajectoryChargeFilter.cc.

{
  G4double charge = traj.GetCharge();
 
  if (GetVerbose()) G4cout<<"G4TrajectoryChargeFilter processing trajectory with charge: "<<charge<<G4endl;
 
  MyCharge myCharge;
 
  if(charge>0.)      myCharge = Positive; 
  else if(charge<0.) myCharge = Negative; 
  else               myCharge = Neutral; 
 
  std::vector<MyCharge>::const_iterator iter = std::find(fCharges.begin(), fCharges.end(), myCharge);
 
  // Fail if charge not registered 
  if (iter == fCharges.end()) return false;
 
  return true;
}

References fCharges, G4cout, G4endl, G4VTrajectory::GetCharge(), G4SmartFilter< G4VTrajectory >::GetVerbose(), Negative, Neutral, and Positive.

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 G4TrajectoryChargeFilter::Print ( std::ostream &  ostr ) const

virtual

Implements G4SmartFilter< G4VTrajectory >.

Definition at line 86 of file G4TrajectoryChargeFilter.cc.

{
  ostr<<"Charges registered: "<<G4endl;
  std::vector<MyCharge>::const_iterator iter = fCharges.begin();
  
  while (iter != fCharges.end()) {
    ostr<<*iter<<G4endl;    
    iter++;
  }
}

References fCharges, 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.

fCharges

std::vector<MyCharge> G4TrajectoryChargeFilter::fCharges

private

Definition at line 69 of file G4TrajectoryChargeFilter.hh.

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

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.

---

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

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