#include <SpaceChargeICARUS.h>

Inheritance diagram for spacecharge::SpaceChargeICARUS:

Public Member Functions
	SpaceChargeICARUS (fhicl::ParameterSet const &pset)

	SpaceChargeICARUS (SpaceChargeICARUS const &)=delete

virtual	~SpaceChargeICARUS ()=default

bool	Configure (fhicl::ParameterSet const &pset)

bool	Update (uint64_t ts=0)

bool	EnableSimSpatialSCE () const override

bool	EnableSimEfieldSCE () const override

bool	EnableCalSpatialSCE () const override

bool	EnableCalEfieldSCE () const override

bool	EnableCorrSCE () const override

geo::Vector_t	GetPosOffsets (geo::Point_t const &point) const override

geo::Vector_t	GetEfieldOffsets (geo::Point_t const &point) const override

geo::Vector_t	GetCalPosOffsets (geo::Point_t const &point, int const &TPCid) const override

geo::Vector_t	GetCalPosOffsets (geo::Point_t const &point, geo::TPCID const &TPCid) const

geo::Vector_t	GetCalEfieldOffsets (geo::Point_t const &point, int const &TPCid=1) const override

Public Member Functions inherited from spacecharge::SpaceCharge
	SpaceCharge (const SpaceCharge &)=delete

	SpaceCharge (SpaceCharge &&)=delete

SpaceCharge &	operator= (const SpaceCharge &)=delete

SpaceCharge &	operator= (SpaceCharge &&)=delete

virtual	~SpaceCharge ()=default

Protected Member Functions
void	fixCoords (double xx, double yy, double *zz) const

Protected Member Functions inherited from spacecharge::SpaceCharge
	SpaceCharge ()=default

Protected Attributes
std::vector< TH3F * >	SCEhistograms = std::vector<TH3F*>(9)

bool	fEnableSimSpatialSCE

bool	fEnableSimEfieldSCE

bool	fEnableCalSpatialSCE

bool	fEnableCalEfieldSCE

bool	fEnableCorrSCE

std::string	fRepresentationType

std::string	fInputFilename

Detailed Description

Definition at line 38 of file SpaceChargeICARUS.h.

Constructor & Destructor Documentation

spacecharge::SpaceChargeICARUS::SpaceChargeICARUS ( fhicl::ParameterSet const & pset )

explicit

Definition at line 19 of file SpaceChargeICARUS.cxx.

 {
   Configure(pset);
 }

spacecharge::SpaceChargeICARUS::SpaceChargeICARUS ( SpaceChargeICARUS const & )

delete

virtual spacecharge::SpaceChargeICARUS::~SpaceChargeICARUS ( )

virtualdefault

Member Function Documentation

bool spacecharge::SpaceChargeICARUS::Configure ( fhicl::ParameterSet const & pset )

Definition at line 24 of file SpaceChargeICARUS.cxx.

 {
   fEnableSimSpatialSCE = pset.get<bool>("EnableSimSpatialSCE");
   fEnableSimEfieldSCE = pset.get<bool>("EnableSimEfieldSCE");
   //fEnableCorrSCE = pset.get<bool>("EnableCorrSCE");
   fEnableCalSpatialSCE = pset.get<bool>("EnableCalSpatialSCE");
   fEnableCalEfieldSCE = pset.get<bool>("EnableCalEfieldSCE");
 
   std::cout << "Configuring SpaceCharge..." << std::endl;
 
   if((fEnableSimSpatialSCE == true) || (fEnableSimEfieldSCE == true)){
     fRepresentationType = pset.get<std::string>("RepresentationType");
     fInputFilename = pset.get<std::string>("InputFilename");
 
     std::string fname;
     cet::search_path sp("FW_SEARCH_PATH");
     sp.find_file(fInputFilename, fname);
 
     std::unique_ptr<TFile> infile(new TFile(fname.c_str(), "READ"));
     if(!infile->IsOpen()){
       throw cet::exception("SpaceChargeICARUS") << "Could not find the space charge input file '" << fInputFilename << "'!\n";
     }
 
     if(fRepresentationType == "Voxelized_TH3"){
       std::cout << "begin loading voxelized TH3s..." << std::endl;
 
       //Load in histograms
       TH3F* hTrueFwdX = (TH3F*) infile->Get("TrueFwd_Displacement_X");
       TH3F* hTrueFwdY = (TH3F*) infile->Get("TrueFwd_Displacement_Y");
       TH3F* hTrueFwdZ = (TH3F*) infile->Get("TrueFwd_Displacement_Z");
       TH3F* hTrueBkwdX = (TH3F*) infile->Get("TrueBkwd_Displacement_X");
       TH3F* hTrueBkwdY = (TH3F*) infile->Get("TrueBkwd_Displacement_Y");
       TH3F* hTrueBkwdZ = (TH3F*) infile->Get("TrueBkwd_Displacement_Z");
       TH3F* hTrueEFieldX = (TH3F*) infile->Get("True_ElecField_X");
       TH3F* hTrueEFieldY = (TH3F*) infile->Get("True_ElecField_Y");
       TH3F* hTrueEFieldZ = (TH3F*) infile->Get("True_ElecField_Z");
 
       //https://root.cern.ch/doc/master/classTH1.html#a0367fe04ae8709fd4b82795d0a5462c3
       //Set hist directories so they can be referenced elsewhere
       //This needs to be done because they were read in from ext file
       //Note this is not a property of the TH3F, so does't survive copying
       hTrueFwdX->SetDirectory(0);
       hTrueFwdY->SetDirectory(0);
       hTrueFwdZ->SetDirectory(0);
       hTrueBkwdX->SetDirectory(0);
       hTrueBkwdY->SetDirectory(0);
       hTrueBkwdZ->SetDirectory(0);
       hTrueEFieldX->SetDirectory(0);
       hTrueEFieldY->SetDirectory(0);
       hTrueEFieldZ->SetDirectory(0);
 
       //SCEhistograms can be accessed globally in this script
       SCEhistograms = {hTrueFwdX, hTrueFwdY, hTrueFwdZ,
                        hTrueBkwdX, hTrueBkwdY, hTrueBkwdZ,
                        hTrueEFieldX, hTrueEFieldY, hTrueEFieldZ};
 
 
       std::cout << "...finished loading TH3s" << std::endl;
     }
     infile->Close();
   }
   if(fEnableCorrSCE == true){
     //keeping here (for now) for historic reasons
   }
   return true;
 }

bool spacecharge::SpaceChargeICARUS::EnableCalEfieldSCE ( ) const

overridevirtual

Implements spacecharge::SpaceCharge.

Definition at line 116 of file SpaceChargeICARUS.cxx.

 {
   return fEnableCalEfieldSCE;
 }

bool spacecharge::SpaceChargeICARUS::EnableCalSpatialSCE ( ) const

overridevirtual

Implements spacecharge::SpaceCharge.

Definition at line 110 of file SpaceChargeICARUS.cxx.

 {
   return fEnableCalSpatialSCE;
 }

bool spacecharge::SpaceChargeICARUS::EnableCorrSCE ( ) const

inlineoverridevirtual

Implements spacecharge::SpaceCharge.

Definition at line 56 of file SpaceChargeICARUS.h.

56 {return (EnableCalSpatialSCE()||EnableCalEfieldSCE()) ;}

spacecharge::SpaceChargeICARUS::EnableCalEfieldSCE

bool EnableCalEfieldSCE() const override

Definition: SpaceChargeICARUS.cxx:116

spacecharge::SpaceChargeICARUS::EnableCalSpatialSCE

bool EnableCalSpatialSCE() const override

Definition: SpaceChargeICARUS.cxx:110

bool spacecharge::SpaceChargeICARUS::EnableSimEfieldSCE ( ) const

overridevirtual

Implements spacecharge::SpaceCharge.

Definition at line 104 of file SpaceChargeICARUS.cxx.

 {
   return fEnableSimEfieldSCE;
 }

bool spacecharge::SpaceChargeICARUS::EnableSimSpatialSCE ( ) const

overridevirtual

Implements spacecharge::SpaceCharge.

Definition at line 98 of file SpaceChargeICARUS.cxx.

 {
   return fEnableSimSpatialSCE;
 }

void spacecharge::SpaceChargeICARUS::fixCoords	(	double *	xx,
		double *	yy,
		double *	zz
	)		const

protected

Definition at line 234 of file SpaceChargeICARUS.cxx.

                                                                                     {
   //handle the edge cases by projecting SCE corrections onto boundaries
   *xx = abs(*xx);
   if(*xx<61.94){*xx=61.94;}
   if(*xx>358.489){*xx=358.489;}
   if(*yy<-181.86){*yy=-181.86;}
   if(*yy>134.96){*yy=134.96;}
   if(*zz<-894.951){*zz=-894.951;}
   if(*zz>894.9509){*zz=894.9509;}
 }

geo::Vector_t spacecharge::SpaceChargeICARUS::GetCalEfieldOffsets	(	geo::Point_t const &	point,
		int const &	TPCid = `1`
	)		const

inlineoverridevirtual

Implements spacecharge::SpaceCharge.

Definition at line 66 of file SpaceChargeICARUS.h.

66 { return {0.,0.,0.}; }

geo::Vector_t spacecharge::SpaceChargeICARUS::GetCalPosOffsets	(	geo::Point_t const &	point,
		int const &	TPCid
	)		const

overridevirtual

Implements spacecharge::SpaceCharge.

Definition at line 166 of file SpaceChargeICARUS.cxx.

 {
   std::vector<double> theCalPosOffsets;
   //make copies of const vars to modify
   double xx=point.X(), yy=point.Y(), zz=point.Z();
   int tpcid = TPCid;
 
   if(fRepresentationType == "Voxelized_TH3"){
     //handle OOAV by projecting edge cases
     //also only have map for positive cryostat (assume symmetry)
     //need to invert coordinates for cryo0
     double corr=1.;
     if(xx<0){
       corr=-1.0;
     }
 
     bool x_is_pos = xx > 0;
 
     fixCoords(&xx, &yy, &zz); //bring into AV and x = abs(x)
     //handle the depositions that was reconstructed in the wrong TPC   
     //hard code in the cathode faces (got from dump_icarus_geometry.fcl)
     //
     //Gray Putnam: update this check to the split-wire Geometry
     if (x_is_pos && (tpcid == 0 || tpcid == 1) && xx > 210.14 ) { xx = 210.14; }
     if (x_is_pos && (tpcid == 2 || tpcid == 3) && xx < 210.29 ) { xx = 210.29; }
 
     if (!x_is_pos && (tpcid == 2 || tpcid == 3) && xx > 210.14 ) { xx = 210.14; }
     if (!x_is_pos && (tpcid == 0 || tpcid == 1) && xx < 210.29 ) { xx = 210.29; }
 
     double offset_x=0., offset_y=0., offset_z=0.;
     offset_x = corr*SCEhistograms.at(3)->Interpolate(xx,yy,zz);
     offset_y = SCEhistograms.at(4)->Interpolate(xx,yy,zz);
     offset_z = SCEhistograms.at(5)->Interpolate(xx,yy,zz);
     theCalPosOffsets = {offset_x, offset_y, offset_z};
   }else{
     theCalPosOffsets.resize(3, 0.0);
   }
   
   return { theCalPosOffsets[0], theCalPosOffsets[1], theCalPosOffsets[2] };
 }

geo::Vector_t spacecharge::SpaceChargeICARUS::GetCalPosOffsets	(	geo::Point_t const &	point,
		geo::TPCID const &	TPCid
	)		const

Definition at line 207 of file SpaceChargeICARUS.cxx.

 {
   return GetCalPosOffsets(point, TPCid.TPC);
 }

geo::Vector_t spacecharge::SpaceChargeICARUS::GetEfieldOffsets ( geo::Point_t const & point ) const

overridevirtual

Implements spacecharge::SpaceCharge.

Definition at line 213 of file SpaceChargeICARUS.cxx.

 {
   //chiefly utilized by larsim, ISCalculationSeparate
   //the magnitude of the Efield is most important
   std::vector<double> theEfieldOffsets;
   double xx=point.X(), yy=point.Y(), zz=point.Z();
   double offset_x=0., offset_y=0., offset_z=0.;
 
   if(fRepresentationType == "Voxelized_TH3"){
     //handle OOAV by projecting edge cases
     //also only have map for positive cryostat (assume symmetry)
     fixCoords(&xx, &yy, &zz);
     offset_x = SCEhistograms.at(6)->Interpolate(xx, yy, zz);
     offset_y = SCEhistograms.at(7)->Interpolate(xx, yy, zz);
     offset_z = SCEhistograms.at(8)->Interpolate(xx, yy, zz);
 
     theEfieldOffsets = {offset_x, offset_y, offset_z};
   }
   return { theEfieldOffsets[0], theEfieldOffsets[1], theEfieldOffsets[2] };
 }

geo::Vector_t spacecharge::SpaceChargeICARUS::GetPosOffsets ( geo::Point_t const & point ) const

overridevirtual

Implements spacecharge::SpaceCharge.

Definition at line 126 of file SpaceChargeICARUS.cxx.

 {
   std::vector<double> thePosOffsets;
   double xx=point.X(), yy=point.Y(), zz=point.Z();
   double cryo_corr=1., tpc_corr=1.;
 
   if(fRepresentationType == "Voxelized_TH3"){
     //handle OOAV by projecting edge cases
     //also only have map for positive cryostat (assume symmetry)
     //need to invert coordinates for cryo0 (cryo_corr)
 
     //in larsim, this is how the offsets are used in DriftElectronstoPlane_module
     // DriftDistance += -1.0 * thePosOffsets[0]
     // thus need to apply correction to TPCs "left" of cryostat (tpc_corr)
     // cathode spans x=210.14 and x=210.29 in pos cryostat
     if(xx>0){
       cryo_corr=1.0;
       if(xx<210.14){
         tpc_corr=-1.0;
       }
     }else{
       cryo_corr=-1.0;
       if(xx<-210.29){
         tpc_corr=-1.0;
       }
     }
     fixCoords(&xx, &yy, &zz); //bring into AV and x = abs(x)
     double offset_x=0., offset_y=0., offset_z=0.;
     offset_x = tpc_corr*cryo_corr*SCEhistograms.at(0)->Interpolate(xx,yy,zz);
     offset_y = SCEhistograms.at(1)->Interpolate(xx,yy,zz);
     offset_z = SCEhistograms.at(2)->Interpolate(xx,yy,zz);
     thePosOffsets = {offset_x, offset_y, offset_z};
   }else{
     thePosOffsets.resize(3, 0.0);
   }
 
   return { thePosOffsets[0], thePosOffsets[1], thePosOffsets[2] };
 }

bool spacecharge::SpaceChargeICARUS::Update ( uint64_t ts = 0 )

Definition at line 91 of file SpaceChargeICARUS.cxx.

 {
   if (ts == 0){return false;}
   return true;
 }

Member Data Documentation

bool spacecharge::SpaceChargeICARUS::fEnableCalEfieldSCE

protected

Definition at line 82 of file SpaceChargeICARUS.h.

bool spacecharge::SpaceChargeICARUS::fEnableCalSpatialSCE

protected

Definition at line 81 of file SpaceChargeICARUS.h.

bool spacecharge::SpaceChargeICARUS::fEnableCorrSCE

protected

Definition at line 83 of file SpaceChargeICARUS.h.

bool spacecharge::SpaceChargeICARUS::fEnableSimEfieldSCE

protected

Definition at line 80 of file SpaceChargeICARUS.h.

bool spacecharge::SpaceChargeICARUS::fEnableSimSpatialSCE

protected

Definition at line 79 of file SpaceChargeICARUS.h.

std::string spacecharge::SpaceChargeICARUS::fInputFilename

protected

Definition at line 85 of file SpaceChargeICARUS.h.

std::string spacecharge::SpaceChargeICARUS::fRepresentationType

protected

Definition at line 84 of file SpaceChargeICARUS.h.

std::vector<TH3F*> spacecharge::SpaceChargeICARUS::SCEhistograms = std::vector<TH3F*>(9)

protected

Definition at line 74 of file SpaceChargeICARUS.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation