#include <SpaceChargeProtoDUNEdp.h>

Inheritance diagram for spacecharge::SpaceChargeProtoDUNEdp:

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

	SpaceChargeProtoDUNEdp (SpaceChargeProtoDUNEdp const &)=delete

virtual	~SpaceChargeProtoDUNEdp ()=default

bool	Configure (fhicl::ParameterSet const &pset, detinfo::DetectorPropertiesData const &)

bool	Update (uint64_t ts=0)

bool	EnableSimSpatialSCE () const override

bool	EnableSimEfieldSCE () const override

bool	EnableCalSpatialSCE () const override
	Return boolean indicating whether or not to apply SCE corrections. More...

bool	EnableCalEfieldSCE () const override
	Return boolean indicating whether or not to apply SCE corrections. More...

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	GetCalEfieldOffsets (geo::Point_t const &point, int const &TPCid) 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
std::vector< double >	GetOffsetsVoxel (geo::Point_t const &point, TH3F hX, TH3F hY, TH3F *hZ) const
	Provides position offsets using voxelized interpolation. More...

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

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

std::vector< TH3F * >	CalSCEhistograms = std::vector<TH3F*>(6)

short int	driftcoordinate

Double_t	Anodebin

bool	fEnableSimSpatialSCE

bool	fEnableSimEfieldSCE

bool	fEnableCalSpatialSCE

bool	fEnableCalEfieldSCE

bool	fEnableCorrSCE

double	fEfield

std::string	fRepresentationType

std::string	fInputFilename

std::string	fCalInputFilename

Detailed Description

Definition at line 28 of file SpaceChargeProtoDUNEdp.h.

Constructor & Destructor Documentation

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

explicit

Definition at line 40 of file SpaceChargeProtoDUNEdp.cxx.

 {
   driftcoordinate=0;
   //Configure(pset);
 }

spacecharge::SpaceChargeProtoDUNEdp::SpaceChargeProtoDUNEdp ( SpaceChargeProtoDUNEdp const & )

delete

virtual spacecharge::SpaceChargeProtoDUNEdp::~SpaceChargeProtoDUNEdp ( )

virtualdefault

Member Function Documentation

bool spacecharge::SpaceChargeProtoDUNEdp::Configure	(	fhicl::ParameterSet const &	pset,
		detinfo::DetectorPropertiesData const &	detProp
	)

Definition at line 48 of file SpaceChargeProtoDUNEdp.cxx.

 {
 
   fEnableSimSpatialSCE = pset.get<bool>("EnableSimSpatialSCE");
   fEnableSimEfieldSCE = pset.get<bool>("EnableSimEfieldSCE");
   fEnableCalSpatialSCE = pset.get<bool>("EnableCalSpatialSCE");
   fEnableCalEfieldSCE = pset.get<bool>("EnableCalEfieldSCE");
 
   fEfield = detProp.Efield();
   std::cout<<"Efield : "<<fEfield<<std::endl;
 
   art::ServiceHandle<geo::Geometry> geom;
   //  auto const* geom = lar::providerFrom<geo::GeometryCore>();
   driftcoordinate = geom->TPC(0).DetectDriftDirection();
   if( driftcoordinate==1 || driftcoordinate==2 )
    {
         std::cout<<" drift coordinate: "<<driftcoordinate<<std::endl;
    }else{ throw cet::exception("CRTGen") << "unknown drift coordinate "<< driftcoordinate << " \n"; }
 
 
      /*    +1: positive x
        +2: positive y
        +3: positive z
        -1: negative x
        -2: negative y
        -3: negative z
        0: other (or algorithm failed)
      */
 
 
   if((fEnableSimSpatialSCE == true) || (fEnableSimEfieldSCE == true))
   {
 
     //x,y, z (drift is x)
 
     fInputFilename = pset.get<std::string>("InputFilename");
 
 
     std::string fname;
     cet::search_path sp("FW_SEARCH_PATH");
     sp.find_file(fInputFilename,fname);
     std::cout<<"spacecharge dualphase protodune: Find file: "<<fInputFilename<<" "<<fname<<std::endl;
 
     std::unique_ptr<TFile> infile(new TFile(fname.c_str(), "READ"));
     if(!infile->IsOpen()) throw cet::exception("SpaceChargeProtoDUNEdp") << "Could not find the space charge effect file '" << fname << "'!\n";
     // units are cm and V/cm
     //   if (fRepresentationType == "Voxelized_TH3") {
     //set up for driftcoordinate=1, driftcoordinate=2 is y-axis drift
     // drift coordinate uses -> hDeltaLength
     TH3F* hDx_sim_orig;
     TH3F* hDy_sim_orig;
     TH3F* hEndPoint_sim_orig; //was X
     if (driftcoordinate==1){
       hDx_sim_orig= (TH3F*)infile->Get("hDeltaLength");
       hDy_sim_orig = (TH3F*)infile->Get("hEndPointDY");
       hEndPoint_sim_orig = (TH3F*)infile->Get("hEndPointX");
       Anodebin = hEndPoint_sim_orig->GetXaxis()->GetXmax();
 
     }else if (driftcoordinate==2){
       hDx_sim_orig= (TH3F*)infile->Get("hEndPointDX");
       hDy_sim_orig = (TH3F*)infile->Get("hDeltaLength");
       hEndPoint_sim_orig = (TH3F*)infile->Get("hEndPointY");
       Anodebin = hEndPoint_sim_orig->GetYaxis()->GetXmax();//?
     }else{
       throw cet::exception("SpaceChargeProtoDUNEdp") << "Driftcoordinate "<<driftcoordinate<<" unknown\n";
     }
 
     TH3F* hDz_sim_orig = (TH3F*)infile->Get("hEndPointDZ");
     TH3F* hEx_sim_orig = (TH3F*)infile->Get("hEx");
     TH3F* hEy_sim_orig = (TH3F*)infile->Get("hEy");
     TH3F* hEz_sim_orig = (TH3F*)infile->Get("hEz");
 
 
 
     TH3F* hEndPointDrift_sim = (TH3F*) hEndPoint_sim_orig->Clone("hEndPointDrift");
 
     TH3F* hDx_sim = (TH3F*)hDx_sim_orig->Clone("hDx_sim");
     TH3F* hDy_sim = (TH3F*)hDy_sim_orig->Clone("hDy_sim");
     TH3F* hDz_sim = (TH3F*)hDz_sim_orig->Clone("hDz_sim");
     TH3F* hEx_sim = (TH3F*)hEx_sim_orig->Clone("hEx_sim");
     TH3F* hEy_sim = (TH3F*)hEy_sim_orig->Clone("hEy_sim");
     TH3F* hEz_sim = (TH3F*)hEz_sim_orig->Clone("hEz_sim");
 
     hEndPointDrift_sim->SetDirectory(0);
 
     hDx_sim->SetDirectory(0);
     hDy_sim->SetDirectory(0);
     hDz_sim->SetDirectory(0);
     hEx_sim->SetDirectory(0);
     hEy_sim->SetDirectory(0);
     hEz_sim->SetDirectory(0);
 
 
 
     SCEhistograms = {hDx_sim, hDy_sim, hDz_sim, hEx_sim, hEy_sim, hEz_sim, hEndPointDrift_sim};
 
       //   } //other representations not included yet..
 
   }
   fEnableCalEfieldSCE = false;
   fEnableCalSpatialSCE = false;
 
    if((fEnableCalSpatialSCE == true) || (fEnableCalEfieldSCE == true))
   {
 
 
     fCalInputFilename = pset.get<std::string>("CalibrationInputFilename");
 
     std::string fname;
     cet::search_path sp("FW_SEARCH_PATH");
     sp.find_file(fCalInputFilename,fname);
     std::cout<<"spacecharge dualphase protodune: Find file: "<<fCalInputFilename<<" "<<fname<<std::endl;
 
     std::unique_ptr<TFile> calinfile(new TFile(fname.c_str(), "READ"));
     if(!calinfile->IsOpen()) throw cet::exception("SpaceChargeProtoDUNEdp") << "Could not find the space charge effect calibration file '" << fname << "'!\n";
 
     TH3F* hDx_cal_orig = (TH3F*)calinfile->Get("hoffsetX");
     TH3F* hDy_cal_orig = (TH3F*)calinfile->Get("hoffsetY");
     TH3F* hDz_cal_orig = (TH3F*)calinfile->Get("hoffsetZ");
 
     TH3F* hEx_cal_orig = (TH3F*)calinfile->Get("hEx");
     TH3F* hEy_cal_orig = (TH3F*)calinfile->Get("hEy");
     TH3F* hEz_cal_orig = (TH3F*)calinfile->Get("hEz");
 
 
 
     TH3F* hDx_cal = (TH3F*)hDx_cal_orig->Clone("hDx_cal");
     TH3F* hDy_cal = (TH3F*)hDy_cal_orig->Clone("hDy_cal");
     TH3F* hDz_cal = (TH3F*)hDz_cal_orig->Clone("hDz_cal");
     TH3F* hEx_cal = (TH3F*)hEx_cal_orig->Clone("hEx_cal");
     TH3F* hEy_cal = (TH3F*)hEy_cal_orig->Clone("hEy_cal");
     TH3F* hEz_cal = (TH3F*)hEz_cal_orig->Clone("hEz_cal");
 
     hDx_cal->SetDirectory(0);
     hDy_cal->SetDirectory(0);
     hDz_cal->SetDirectory(0);
     hEx_cal->SetDirectory(0);
     hEy_cal->SetDirectory(0);
     hEz_cal->SetDirectory(0);
 
 
 
     CalSCEhistograms = {hDx_cal, hDy_cal, hDz_cal, hEx_cal, hEy_cal, hEz_cal};
 
 
 
 
 
    }
 
 
   return true;
 }

bool spacecharge::SpaceChargeProtoDUNEdp::EnableCalEfieldSCE ( ) const

overridevirtual

Return boolean indicating whether or not to apply SCE corrections.

Implements spacecharge::SpaceCharge.

Definition at line 236 of file SpaceChargeProtoDUNEdp.cxx.

 {
   return fEnableCalEfieldSCE;
 }

bool spacecharge::SpaceChargeProtoDUNEdp::EnableCalSpatialSCE ( ) const

overridevirtual

Return boolean indicating whether or not to apply SCE corrections.

Return boolean indicating whether or not to apply SCE corrections

Implements spacecharge::SpaceCharge.

Definition at line 230 of file SpaceChargeProtoDUNEdp.cxx.

 {
   return fEnableCalSpatialSCE;
 }

bool spacecharge::SpaceChargeProtoDUNEdp::EnableCorrSCE ( ) const

inlineoverridevirtual

Implements spacecharge::SpaceCharge.

Definition at line 43 of file SpaceChargeProtoDUNEdp.h.

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

spacecharge::SpaceChargeProtoDUNEdp::EnableCalEfieldSCE

bool EnableCalEfieldSCE() const override

Return boolean indicating whether or not to apply SCE corrections.

Definition: SpaceChargeProtoDUNEdp.cxx:236

spacecharge::SpaceChargeProtoDUNEdp::EnableCalSpatialSCE

bool EnableCalSpatialSCE() const override

Return boolean indicating whether or not to apply SCE corrections.

Definition: SpaceChargeProtoDUNEdp.cxx:230

bool spacecharge::SpaceChargeProtoDUNEdp::EnableSimEfieldSCE ( ) const

overridevirtual

Return boolean indicating whether or not to turn simulation of SCE on for E field distortions

Implements spacecharge::SpaceCharge.

Definition at line 218 of file SpaceChargeProtoDUNEdp.cxx.

 {
   return fEnableSimEfieldSCE;
 }

bool spacecharge::SpaceChargeProtoDUNEdp::EnableSimSpatialSCE ( ) const

overridevirtual

Return boolean indicating whether or not to turn simulation of SCE on for spatial distortions

Implements spacecharge::SpaceCharge.

Definition at line 211 of file SpaceChargeProtoDUNEdp.cxx.

 {
   return fEnableSimSpatialSCE;
 }

geo::Vector_t spacecharge::SpaceChargeProtoDUNEdp::GetCalEfieldOffsets	(	geo::Point_t const &	tmp_point,
		int const &	TPCid
	)		const

overridevirtual

Primary working method of service that provides E field offsets to be used in charge/light yield calculation (e.g.) for calibration

Implements spacecharge::SpaceCharge.

Definition at line 521 of file SpaceChargeProtoDUNEdp.cxx.

 { //not implemented yet..
   std::vector<double> theEfieldOffsets;
   geo::Point_t point = tmp_point;
 
 
   // Efieldoffset or ratio of Efield?
 
   //if (fRepresentationType == "Voxelized_TH3"){
 
     theEfieldOffsets = GetOffsetsVoxel(point, CalSCEhistograms.at(3), CalSCEhistograms.at(4), CalSCEhistograms.at(5));
       //   }else
       //theEfieldOffsets.resize(3,0.0);
 
   return { -theEfieldOffsets[0], -theEfieldOffsets[1], -theEfieldOffsets[2] };
 }

geo::Vector_t spacecharge::SpaceChargeProtoDUNEdp::GetCalPosOffsets	(	geo::Point_t const &	tmp_point,
		int const &	TPCid
	)		const

overridevirtual

Primary working method of service that provides position offsets to be used in calibration of space charge

Implements spacecharge::SpaceCharge.

Definition at line 286 of file SpaceChargeProtoDUNEdp.cxx.

 {
 
   std::vector<double> thePosOffsets;
    geo::Point_t point = tmp_point;
 
   //  if (fRepresentationType == "Voxelized_TH3"){
 
       thePosOffsets = GetOffsetsVoxel(point, CalSCEhistograms.at(0), CalSCEhistograms.at(1), CalSCEhistograms.at(2));
 
       // } else thePosOffsets.resize(3,0.0);
 
   return { thePosOffsets[0], thePosOffsets[1], thePosOffsets[2] };
 }

geo::Vector_t spacecharge::SpaceChargeProtoDUNEdp::GetEfieldOffsets ( geo::Point_t const & tmp_point ) const

overridevirtual

Primary working method of service that provides E field offsets to be used in charge/light yield calculation (e.g.)

Implements spacecharge::SpaceCharge.

Definition at line 462 of file SpaceChargeProtoDUNEdp.cxx.

 {
 
   std::vector<double> theEfieldOffsets;
   geo::Point_t point = {tmp_point.X(), tmp_point.Y(), tmp_point.Z()};
 
 
 
        theEfieldOffsets = GetOffsetsVoxel(point, SCEhistograms.at(3), SCEhistograms.at(4), SCEhistograms.at(5));
        //THESE are the absoluted values of the Efield
        //ISCalculation expects difference from expected field
        /*
  geo::Point_t midPoint
       { ( step->GetPreStepPoint()->GetPosition() + step->GetPostStepPoint()->Ge\
 tPosition() ) * 0.5/CLHEP::cm };
     auto EfieldDelta = fEfield * SCE->GetEfieldOffsets(midPoint);
     geo::Vector_t EfieldVec
       = { fEfield + EfieldDelta.X(), EfieldDelta.Y(), EfieldDelta.Z() };
       std::cout<<"ISCalculation : "<<EfieldVec.R()<<std::endl;    return EfieldVe\
 c.R();
         */
        //     fEfield = detprop->Efield(); kV/cm..
        // Efield in larsoft is in kV/cm
        //std::cout<<"SpaceCharge efield: "<<pow( pow(theEfieldOffsets[0],2) + pow(theEfieldOffsets[1],2) +pow(theEfieldOffsets[2],2) ,0.5)/1000.0<<std::endl;
 
 
        //These maps are in: V/cm
        theEfieldOffsets[0]= theEfieldOffsets[0]/(-1000.0);
        theEfieldOffsets[1]= theEfieldOffsets[1]/(-1000.0);
        theEfieldOffsets[2]= theEfieldOffsets[2]/(-1000.0);
 
        if(driftcoordinate==1){
        theEfieldOffsets[0]=theEfieldOffsets[0]-fEfield;
 
        }else if(driftcoordinate==2){
          theEfieldOffsets[1]=theEfieldOffsets[1]-fEfield;
        }else{
          std::cout<<" Problem with drift field coordiate system for Efield calculation "<<std::endl;
        }
        theEfieldOffsets[0]= theEfieldOffsets[0]/(fEfield);
        theEfieldOffsets[1]= theEfieldOffsets[1]/(fEfield);
        theEfieldOffsets[2]= theEfieldOffsets[2]/(fEfield);
 
 
 
        //       std::cout<<theEfieldOffsets[0]<<" "<<theEfieldOffsets[1]<<" "<<
        //theEfieldOffsets[2]<<std::endl;
 
 
      //  }  else theEfieldOffsets.resize(3,0.0);
 
    return { theEfieldOffsets[0], theEfieldOffsets[1], theEfieldOffsets[2] };
    // }
 
 
 }

std::vector< double > spacecharge::SpaceChargeProtoDUNEdp::GetOffsetsVoxel	(	geo::Point_t const &	point,
		TH3F *	hX,
		TH3F *	hY,
		TH3F *	hZ
	)		const

protected

Provides position offsets using voxelized interpolation.

Definition at line 429 of file SpaceChargeProtoDUNEdp.cxx.

 {
 
   if (isWithinHist(point, hX) && isWithinHist(point, hY) && isWithinHist(point, hZ)) {
 
     //need to check, X Y and Z on all three histograms..
 
     return {
         hX->Interpolate(point.X(),point.Y(),point.Z()),
         hY->Interpolate(point.X(),point.Y(),point.Z()),
         hZ->Interpolate(point.X(),point.Y(),point.Z())
     };
   }
   if (isWithinHistOuter(point, hX) && isWithinHistOuter(point, hY) && isWithinHistOuter(point, hZ)) {
   //use Laura's extrapolation method
     //    std::cout<<"extrap: ";
 
   return {ExtrapolateAtEdge(hX, point.X(),point.Y(),point.Z()),
           ExtrapolateAtEdge(hY,point.X(),point.Y(),point.Z()),
          ExtrapolateAtEdge(hZ,point.X(),point.Y(),point.Z())};
   }
   //  std::cout<<"outside: ";
       return {0.0,0.0,0.0}; //no offset and no efield!
 
 
 
 }

geo::Vector_t spacecharge::SpaceChargeProtoDUNEdp::GetPosOffsets ( geo::Point_t const & tmp_point ) const

overridevirtual

Primary working method of service that provides position offsets to be used in ionization electron drift

Implements spacecharge::SpaceCharge.

Definition at line 243 of file SpaceChargeProtoDUNEdp.cxx.

 {
   //x [-300,300], y [-300,300], z[0,600]
   std::vector<double> thePosOffsets;
   geo::Point_t point = {tmp_point.X(), tmp_point.Y(), tmp_point.Z()};
 
 
   //  if (fRepresentationType=="Voxelized_TH3"){
 
         thePosOffsets = GetOffsetsVoxel(point, SCEhistograms.at(0), SCEhistograms.at(1), SCEhistograms.at(2));
         //drift offset = bended trajectory  - straight, LArVoxelReadout requires (straight-bended), so flip
 
 
         //}  else thePosOffsets.resize(3,0.0);
 
         //CHECK EndPointX (does this point get to the anode?), if not make offsets so large point goes outside volume...
         //      std::cout<<"pos: "<< tmp_point.X()<<" "<< tmp_point.Y()<<std::endl;
 
         if(isWithinHist(point, SCEhistograms.at(6)))
           {
             // std::cout<<"within..?"<<SCEhistograms.at(6)->Interpolate(point.X(), point.Y(), point.Z())<<" "<<SCEhistograms.at(6)->GetXaxis()->GetXmax()<<std::endl;
             if (SCEhistograms.at(6)->Interpolate(point.X(), point.Y(), point.Z()) >= Anodebin )
               {
 
                 //                    std::cout<<"hits anode: "<< tmp_point.X()<<" "<< tmp_point.Y()<<" "<< tmp_point.Z()<<" "<<thePosOffsets[0]<<" "<< thePosOffsets[1]<<" "<< thePosOffsets[2]<<std::endl;
                 if(driftcoordinate==1){
                   return {-thePosOffsets[0], thePosOffsets[1], thePosOffsets[2] };
                 }else if (driftcoordinate==2)
                    { //is Voxel ready for y-shift?
                      return {thePosOffsets[0], -thePosOffsets[1], thePosOffsets[2] };
                    }else{
                   throw cet::exception("SpaceChargeProtoDUNEdp") << "Driftcoordinate "<<driftcoordinate<<" unknown\n";
                 }
             }
           }
 
           return {9999999,9999999,9999999 };
 
           }

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

Definition at line 203 of file SpaceChargeProtoDUNEdp.cxx.

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

Member Data Documentation

Double_t spacecharge::SpaceChargeProtoDUNEdp::Anodebin

protected

Definition at line 59 of file SpaceChargeProtoDUNEdp.h.

std::vector<TH3F*> spacecharge::SpaceChargeProtoDUNEdp::CalSCEhistograms = std::vector<TH3F*>(6)

protected

Definition at line 56 of file SpaceChargeProtoDUNEdp.h.

short int spacecharge::SpaceChargeProtoDUNEdp::driftcoordinate

protected

Definition at line 58 of file SpaceChargeProtoDUNEdp.h.

std::string spacecharge::SpaceChargeProtoDUNEdp::fCalInputFilename

protected

Definition at line 73 of file SpaceChargeProtoDUNEdp.h.

double spacecharge::SpaceChargeProtoDUNEdp::fEfield

protected

Definition at line 69 of file SpaceChargeProtoDUNEdp.h.

bool spacecharge::SpaceChargeProtoDUNEdp::fEnableCalEfieldSCE

protected

Definition at line 66 of file SpaceChargeProtoDUNEdp.h.

bool spacecharge::SpaceChargeProtoDUNEdp::fEnableCalSpatialSCE

protected

Definition at line 65 of file SpaceChargeProtoDUNEdp.h.

bool spacecharge::SpaceChargeProtoDUNEdp::fEnableCorrSCE

protected

Definition at line 67 of file SpaceChargeProtoDUNEdp.h.

bool spacecharge::SpaceChargeProtoDUNEdp::fEnableSimEfieldSCE

protected

Definition at line 64 of file SpaceChargeProtoDUNEdp.h.

bool spacecharge::SpaceChargeProtoDUNEdp::fEnableSimSpatialSCE

protected

Definition at line 63 of file SpaceChargeProtoDUNEdp.h.

std::string spacecharge::SpaceChargeProtoDUNEdp::fInputFilename

protected

Definition at line 72 of file SpaceChargeProtoDUNEdp.h.

std::string spacecharge::SpaceChargeProtoDUNEdp::fRepresentationType

protected

Definition at line 71 of file SpaceChargeProtoDUNEdp.h.

std::vector<TH3F*> spacecharge::SpaceChargeProtoDUNEdp::SCEhistograms = std::vector<TH3F*>(7)

protected

Definition at line 55 of file SpaceChargeProtoDUNEdp.h.

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

dunesim/dunesim/SpaceCharge/SpaceChargeProtoDUNEdp.h
dunesim/dunesim/SpaceCharge/SpaceChargeProtoDUNEdp.cxx

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation