LMU/musrfit
5
0
Fork 0
Code Issues 6 Pull Requests Actions Packages Projects Releases 4 Activity

added minimal NeXus IDF 2 support.

Browse Source
This commit is contained in:
nemu
2011-08-23 17:22:29 +00:00
parent b67a19d406
commit 03b9fe1e71
12 changed files with 5355 additions and 1845 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/external/nexus/Makefile.am vendored
View File

@ -5,7 +5,7 @@ h_sources = \
PNeXus.h
cpp_sources = \
PNeXus.cpp
PNeXus.cpp
include_HEADERS = $(h_sources)

5708
src/external/nexus/PNeXus.cpp vendored
View File

File diff suppressed because it is too large Load Diff

773
src/external/nexus/PNeXus.h vendored
View File

@ -32,7 +32,6 @@
#ifndef _PNEXUS_H_
#define _PNEXUS_H_
#include <iostream>
#include <string>
#include <vector>
using namespace std;
@ -43,271 +42,581 @@ using namespace std;
#define VGNAMELENMAX 64
#endif /* VGNAMELENMAX */
#define PNEXUS_FILE_OPEN_ERROR 0
#define PNEXUS_GROUP_OPEN_ERROR 1
#define PNEXUS_OPEN_DATA_ERROR 2
#define PNEXUS_GET_DATA_ERROR 3
#define PNEXUS_GET_ATTR_ERROR 4
#define PNEXUS_CLOSE_DATA_ERROR 5
#define PNEXUS_GET_META_INFO_ERROR 6
#define PNEXUS_WRONG_META_INFO 7
#define PNEXUS_WRONG_DATE_FORMAT 8
#define PNEXUS_WRONG_TIME_FORMAT 9
#define PNEXUS_INIT_GROUPDIR_ERROR 10
#define PNEXUS_GET_GROUP_INFO_ERROR 11
#define PNEXUS_GET_NEXT_ENTRY_ERROR 12
#define PNEXUS_HISTO_ERROR 13
#define PNEXUS_SET_ATTR_ERROR 14
#define PNEXUS_CREATE_GROUP_ERROR 15
#define PNEXUS_MAKE_DATA_ERROR 16
#define PNEXUS_PUT_DATA_ERROR 17
#define PNEXUS_PUT_ATTR_ERROR 18
#define PNEXUS_NO_ERROR 0
#define PNEXUS_NXENTRY_NOT_FOUND 1
#define PNEXUS_FILE_OPEN_ERROR 2
#define PNEXUS_GROUP_OPEN_ERROR 3
#define PNEXUS_OPEN_DATA_ERROR 4
#define PNEXUS_GET_DATA_ERROR 5
#define PNEXUS_GET_ATTR_ERROR 6
#define PNEXUS_CLOSE_DATA_ERROR 7
#define PNEXUS_GET_META_INFO_ERROR 8
#define PNEXUS_WRONG_META_INFO 9
#define PNEXUS_WRONG_DATE_FORMAT 10
#define PNEXUS_WRONG_TIME_FORMAT 11
#define PNEXUS_INIT_GROUPDIR_ERROR 12
#define PNEXUS_GET_GROUP_INFO_ERROR 13
#define PNEXUS_GET_NEXT_ENTRY_ERROR 14
#define PNEXUS_HISTO_ERROR 15
#define PNEXUS_SET_ATTR_ERROR 16
#define PNEXUS_CREATE_GROUP_ERROR 17
#define PNEXUS_MAKE_DATA_ERROR 18
#define PNEXUS_PUT_DATA_ERROR 19
#define PNEXUS_PUT_ATTR_ERROR 20
#define PNEXUS_IDF_NOT_IMPLEMENTED 21
#define PNEXUS_VAILD_READ_IDF1_FILE 22
#define PNEXUS_VAILD_READ_IDF2_FILE 23
#define PNEXUS_OBJECT_INVOK_ERROR 24
#define PNEXUS_TIME_FORMAT_ERROR 25
#define PNEXUS_DATA_ERROR 26
#define PNEXUS_NXUSER_NOT_FOUND 27
#define PNEXUS_LINKING_ERROR 28
//-----------------------------------------------------------------------------
/**
*
*/
typedef struct {
string fUserName;
string fExperimentNumber;
} PNeXusUser;
class PNeXusProp {
public:
PNeXusProp();
virtual ~PNeXusProp() {}
//-----------------------------------------------------------------------------
/**
*
*/
typedef struct {
string fName;
double fTemperature;
string fTemperatureUnit;
double fMagneticField;
string fMagneticFieldUnit;
string fShape;
string fMagneticFieldState; ///< ZF, TF, LF
int fMagneticFieldVectorAvailable;
vector<double> fMagneticFieldVector;
string fMagneticFieldVectorUnits;
string fMagneticFieldVectorCoordinateSystem;
string fEnvironment;
} PNeXusSample;
virtual string GetName() { return fName; }
virtual double GetValue() { return fValue; }
virtual string GetUnit() { return fUnit; }
//-----------------------------------------------------------------------------
/**
* <p> currently only put in the requiered ones.
*/
typedef struct {
int number;
} PNeXusDetector;
virtual void SetName(string name) { fName = name; }
virtual void SetValue(double val) { fValue = val; }
virtual void SetUnit(string unit) { fUnit = unit; }
//-----------------------------------------------------------------------------
/**
* <p> currently only put in the requiered ones.
*/
typedef struct {
string type;
} PNeXusCollimator;
private:
string fName;
double fValue;
string fUnit;
};
//-----------------------------------------------------------------------------
/**
* <p> currently only put in the requiered ones.
*/
typedef struct {
double total_counts;
string total_counts_units;
} PNeXusBeam;
class PNeXusBeam1 {
public:
PNeXusBeam1() { fTotalCounts = 0; fUnits = "n/a"; }
virtual ~PNeXusBeam1() {}
//-----------------------------------------------------------------------------
/**
*
*/
typedef struct {
string name;
PNeXusDetector detector;
PNeXusCollimator collimator;
PNeXusBeam beam;
} PNeXusInstrument;
virtual bool IsValid(bool strict);
//-----------------------------------------------------------------------------
/**
*
*/
typedef struct {
unsigned int fGroupFirst;
unsigned int fGroupSecond;
double fAlphaVal;
} PNeXusAlpha;
virtual double GetTotalCounts() { return fTotalCounts; }
virtual string GetUnits() { return fUnits; }
//-----------------------------------------------------------------------------
/**
*
*/
typedef struct {
double fTimeResolution; ///< time resolution in (ns)
unsigned int fNumberOfHistos;
vector<unsigned int> fT0;
vector<unsigned int> fFirstGoodBin;
vector<unsigned int> fLastGoodBin;
vector<string> fHistoName;
vector< vector<unsigned int> > fHisto;
vector<unsigned int> fGrouping;
vector<PNeXusAlpha> fAlpha;
} PNeXusData;
virtual void SetTotalCounts(double counts) { fTotalCounts = counts; }
virtual void SetUnits(string units) { fUnits = units; }
private:
double fTotalCounts; ///< total number of counts
string fUnits; ///< 'units' in which total counts is given, e.g. 'Mev'
};
class PNeXusCollimator1 {
public:
PNeXusCollimator1() { fType = "n/a"; }
virtual ~PNeXusCollimator1() {}
virtual bool IsValid(bool strict) { return true; } // currently only a dummy
virtual string GetType() { return fType; }
virtual void SetType(string type) { fType = type; }
private:
string fType;
};
class PNeXusDetector1 {
public:
PNeXusDetector1() { fNumber = 0; }
virtual ~PNeXusDetector1() {}
virtual bool IsValid(bool strict);
virtual int GetNumber() { return fNumber; }
virtual void SetNumber(int number) { fNumber = number; }
private:
int fNumber;
};
class PNeXusInstrument1 {
public:
PNeXusInstrument1() { fName = "n/a"; }
virtual ~PNeXusInstrument1() {}
virtual bool IsValid(bool strict);
virtual string GetName() { return fName; }
virtual PNeXusDetector1* GetDetector() { return &fDetector; }
virtual PNeXusCollimator1* GetCollimator() { return &fCollimator; }
virtual PNeXusBeam1* GetBeam() { return &fBeam; }
virtual void SetName(string name) { fName = name; }
virtual void SetDetector(PNeXusDetector1 &detector) { fDetector = detector; }
virtual void SetCollimator(PNeXusCollimator1 &collimator) { fCollimator = collimator; }
virtual void SetBeam(PNeXusBeam1 &beam) { fBeam = beam; }
private:
string fName; ///< instrument name
PNeXusDetector1 fDetector;
PNeXusCollimator1 fCollimator;
PNeXusBeam1 fBeam;
};
class PNeXusSample1 {
public:
PNeXusSample1();
virtual ~PNeXusSample1();
virtual bool IsValid(bool strict);
virtual string GetName() { return fName; }
virtual string GetShape() { return fShape; }
virtual string GetMagneticFieldState() { return fMagneticFieldState; }
virtual string GetEnvironment() { return fEnvironment; }
virtual double GetPhysPropValue(string name, bool &ok);
virtual void GetPhysPropUnit(string name, string &unit, bool &ok);
virtual int IsMagneticFieldVectorAvailable() { return fMagneticFieldVectorAvailable; }
virtual vector<double> GetMagneticFieldVector() { return fMagneticFieldVector; }
virtual string GetMagneticFieldVectorUnits() { return fMagneticFieldVectorUnits; }
virtual string GetMagneticFieldVectorCoordinateSystem() { return fMagneticFieldVectorCoordinateSystem; }
virtual void SetName(string name) { fName = name; }
virtual void SetShape(string shape) { fShape = shape; }
virtual void SetMagneticFieldState(string magFieldState) { fMagneticFieldState = magFieldState; }
virtual void SetEnvironment(string env) { fEnvironment = env; }
virtual void SetPhysProp(string name, double value, string unit, int idx=-1);
virtual void SetMagneticFieldVectorAvailable(int avail) { fMagneticFieldVectorAvailable = avail; }
virtual void SetMagneticFieldVector(vector<double> &magVec) { fMagneticFieldVector = magVec; }
virtual void SetMagneticFieldVectorCoordinateSystem(string coord) { fMagneticFieldVectorCoordinateSystem = coord; }
virtual void SetMagneticFieldUnits(string units) { fMagneticFieldVectorUnits = units; }
private:
string fName; ///< sample name
string fShape; ///< sample orientation
string fMagneticFieldState; ///< magnetic field state, e.g. TF, ZF, ...
string fEnvironment; ///< sample environment, e.g. CCR, Konti-1, ...
vector<PNeXusProp> fPhysProp; ///< collects the temperature, magnetic field
int fMagneticFieldVectorAvailable; ///< flag '0' magnetic field vector not available, '1' magnetic field vector available
vector<double> fMagneticFieldVector; ///< magnetic field vector
string fMagneticFieldVectorUnits; ///< units in which the magnetic field vector is given
string fMagneticFieldVectorCoordinateSystem; ///< coordinate system, e.g. 'cartesian'
};
class PNeXusUser1 {
public:
PNeXusUser1();
virtual ~PNeXusUser1() {}
virtual bool IsValid(bool strict) { return true; } // currently only a dummy
virtual string GetName() { return fName; }
virtual string GetExperimentNumber() { return fExperimentNumber; }
virtual void SetName(string name) { fName = name; }
virtual void SetExperimentNumber(string expNum) { fExperimentNumber = expNum; }
private:
string fName; ///< user name
string fExperimentNumber; ///< experiment number, RB number at ISIS
};
class PNeXusAlpha1 {
public:
PNeXusAlpha1();
virtual ~PNeXusAlpha1() {}
virtual unsigned int GetGroupFirst() { return fGroupFirst; }
virtual unsigned int GetGroupSecond() { return fGroupSecond; }
virtual double GetAlpha() { return fAlphaVal; }
virtual void SetGroupFirst(unsigned int val) { fGroupFirst = val; }
virtual void SetGroupSecond(unsigned int val) { fGroupSecond = val; }
virtual void SetAlpha(double val) { fAlphaVal = val; }
private:
unsigned int fGroupFirst;
unsigned int fGroupSecond;
double fAlphaVal;
};
class PNeXusData1 {
public:
PNeXusData1() { fTimeResolution = 0.0; }
virtual ~PNeXusData1();
virtual bool IsValid(bool strict);
virtual double GetTimeResolution(string units);
virtual vector<unsigned int> *GetT0s() { return &fT0; }
virtual int GetT0(unsigned int idx);
virtual vector<unsigned int> *GetFirstGoodBins() { return &fFirstGoodBin; }
virtual int GetFirstGoodBin(unsigned int idx);
virtual vector<unsigned int> *GetLastGoodBins() { return &fLastGoodBin; }
virtual int GetLastGoodBin(unsigned int idx);
virtual vector<string> *GetHistoNames() { return &fHistoName; }
virtual void GetHistoName(unsigned int idx, string &name, bool &ok);
virtual unsigned int GetNoOfHistos() { return fHisto.size(); }
virtual vector<unsigned int> *GetHisto(unsigned int histoNo);
virtual vector<int> *GetGrouping() { return &fGrouping; }
virtual vector<PNeXusAlpha1> *GetAlpha() { return &fAlpha; }
virtual void SetTimeResolution(double val, string units);
virtual void SetT0(unsigned int t0, int idx=-1);
virtual void SetFirstGoodBin(unsigned int fgb, int idx=-1);
virtual void SetLastGoodBin(unsigned int lgb, int idx=-1);
virtual void FlushHistos();
virtual void SetHisto(vector<unsigned int> &data, int histoNo=-1);
virtual void FlushGrouping() { fGrouping.clear(); }
virtual void SetGrouping(vector<int> &grouping) { fGrouping = grouping; }
virtual void FlushAlpha() { fAlpha.clear(); }
virtual void SetAlpha(vector<PNeXusAlpha1> &alpha) { fAlpha = alpha; }
private:
double fTimeResolution; ///< time resolution in (ps)
vector<unsigned int> fT0;
vector<unsigned int> fFirstGoodBin;
vector<unsigned int> fLastGoodBin;
vector<string> fHistoName;
vector< vector<unsigned int> > fHisto;
vector<int> fGrouping;
vector<PNeXusAlpha1> fAlpha;
};
class PNeXusEntry1 {
public:
PNeXusEntry1();
virtual ~PNeXusEntry1() {}
virtual bool IsValid(bool strict);
virtual string GetProgramName() { return fProgramName; }
virtual string GetProgramVersion() { return fProgramVersion; }
virtual int GetRunNumber() { return fRunNumber; }
virtual string GetTitle() { return fTitle; }
virtual string GetNotes() { return fNotes; }
virtual string GetAnalysis() { return fAnalysis; }
virtual string GetLaboratory() { return fLaboratory; }
virtual string GetBeamline() { return fBeamline; }
virtual string GetStartTime() { return fStartTime; }
virtual string GetStopTime() { return fStopTime; }
virtual int GetSwitchingState() { return fSwitchingState; }
virtual PNeXusUser1* GetUser() { return &fUser; }
virtual PNeXusSample1* GetSample() { return &fSample; }
virtual PNeXusInstrument1* GetInstrument() { return &fInstrument; }
virtual PNeXusData1* GetData() { return &fData; }
virtual void SetProgramName(string name) { fProgramName = name; }
virtual void SetProgramVersion(string version) { fProgramVersion = version; }
virtual void SetRunNumber(int number) { fRunNumber = number; }
virtual void SetTitle(string title) { fTitle = title; }
virtual void SetNotes(string notes) { fNotes = notes; }
virtual void SetAnalysis(string analysis) { fAnalysis = analysis; }
virtual void SetLaboratory(string lab) { fLaboratory = lab; }
virtual void SetBeamline(string beamline) { fBeamline = beamline; }
virtual int SetStartTime(string time);
virtual int SetStopTime(string time);
virtual int SetSwitchingState(int state);
virtual void SetUser(PNeXusUser1 &user) { fUser = user; }
virtual void SetSample(PNeXusSample1 &sample) { fSample = sample; }
virtual void SetInstrument(PNeXusInstrument1 &instrument) { fInstrument = instrument; }
virtual void SetData(PNeXusData1 &data) { fData = data; }
private:
string fProgramName; ///< name of the creating program
string fProgramVersion; ///< version of the creating program
int fRunNumber; ///< run number
string fTitle; ///< string containing the run title
string fNotes; ///< comments
string fAnalysis; ///< type of muon experiment "muonTD", "ALC", ...
string fLaboratory; ///< name of the laboratory where the data are taken, e.g. PSI, triumf, ISIS, J-Parc
string fBeamline; ///< name of the beamline used for the experiment, e.g. muE4
string fStartTime; ///< start date/time of the run
string fStopTime; ///< stop date/time of the run
int fSwitchingState; ///< '1' normal data collection, '2' Red/Green mode
PNeXusUser1 fUser; ///< NXuser info IDF Version 1
PNeXusSample1 fSample; ///< NXsample info IDF Version 1
PNeXusInstrument1 fInstrument; ///< NXinstrument info IDF Version 1
PNeXusData1 fData; ///< NXdata info IDF Version 1
};
class PNeXusSource2 {
public:
PNeXusSource2();
virtual ~PNeXusSource2() {}
virtual bool IsValid(bool strict);
virtual string GetName() { return fName; }
virtual string GetType() { return fType; }
virtual string GetProbe() { return fProbe; }
virtual void SetName(string name) { fName = name; }
virtual void SetType(string type) { fType = type; }
virtual void SetProbe(string probe) { fProbe = probe; }
private:
string fName; ///< facility name
string fType; ///< continous muon source, pulsed muon source, low energy muon source, ...
string fProbe; ///< positive muon, negative muon
};
class PNeXusBeamline2 {
public:
PNeXusBeamline2() { fName = "n/a"; }
virtual ~PNeXusBeamline2() {}
virtual bool IsValid(bool strict);
virtual string GetName() { return fName; }
virtual void SetName(string name) { fName = name; }
private:
string fName;
};
class PNeXusDetector2 {
public:
PNeXusDetector2();
virtual ~PNeXusDetector2();
virtual bool IsValid(bool strict);
virtual string GetDescription() { return fDescription; }
virtual double GetTimeResolution(string units);
virtual bool IsT0Present() { return (fT0 == 0) ? false : true; }
virtual int GetT0Tag() { return fT0Tag; }
virtual int GetT0(int idxp=-1, int idxs=-1);
virtual int* GetT0s() { return fT0; }
virtual bool IsFirstGoodBinPresent() { return (fFirstGoodBin == 0) ? false : true; }
virtual int GetFirstGoodBin(int idxp=-1, int idxs=-1);
virtual int* GetFirstGoodBins() { return fFirstGoodBin; }
virtual bool IsLastGoodBinPresent() { return (fFirstGoodBin == 0) ? false : true; }
virtual int GetLastGoodBin(int idxp=-1, int idxs=-1);
virtual int* GetLastGoodBins() { return fLastGoodBin; }
virtual int GetNoOfPeriods() { return fNoOfPeriods; }
virtual int GetNoOfSpectra() { return fNoOfSpectra; }
virtual int GetNoOfBins() { return fNoOfBins; }
virtual int GetHistoValue(int idx_p, int idx_s, int idx_b);
virtual int* GetHistos() { return fHisto; }
virtual unsigned int GetSpectrumIndexSize() { return fSpectrumIndex.size(); }
virtual vector<int> *GetSpectrumIndex() { return &fSpectrumIndex; }
virtual int GetSpectrumIndex(unsigned int idx);
virtual void SetDescription(string description) { fDescription = description; }
virtual void SetTimeResolution(double val, string units);
virtual void SetT0Tag(int tag) { fT0Tag = tag; }
virtual void SetT0(int *t0) { fT0 = t0; }
virtual void SetFirstGoodBin(int *fgb) { fFirstGoodBin = fgb; }
virtual void SetLastGoodBin(int *lgb) { fLastGoodBin = lgb; }
virtual void SetNoOfPeriods(int val) { fNoOfPeriods = val; }
virtual void SetNoOfSpectra(int val) { fNoOfSpectra = val; }
virtual void SetNoOfBins(int val) { fNoOfBins = val; }
virtual void SetHisto(int *histo) { fHisto = histo; }
virtual void SetSpectrumIndex(vector<int> spectIdx) { fSpectrumIndex = spectIdx; }
virtual void SetSpectrumIndex(int spectIdx, int idx=-1);
private:
string fDescription; ///< description of the detector
double fTimeResolution; ///< keeps the time resolution in (ps)
vector<int> fSpectrumIndex; ///< list of global spectra
int fNoOfPeriods; ///< number of periods or -1 if not defined
int fNoOfSpectra; ///< number of spectra or -1 if not defined
int fNoOfBins; ///< number of bins of a spectrum or -1 if not defined
int fT0Tag; ///< tag for t0, fgb, lgb structure. -1==not present, 1==NX_INT, 2=NX_INT[np][ns]
int *fT0;
int *fFirstGoodBin;
int *fLastGoodBin;
int *fHisto;
};
class PNeXusInstrument2 {
public:
PNeXusInstrument2() { fName = "n/a"; }
virtual ~PNeXusInstrument2() {}
virtual bool IsValid(bool strict);
virtual string GetName() { return fName; }
virtual PNeXusSource2* GetSource() { return &fSource; }
virtual PNeXusBeamline2* GetBeamline() { return &fBeamline; }
virtual PNeXusDetector2* GetDetector() { return &fDetector; }
virtual void SetName(string name) { fName = name; }
virtual void SetSource(PNeXusSource2 &source) { fSource = source; }
virtual void SetBeamline(PNeXusBeamline2 &beamline) { fBeamline = beamline; }
virtual void SetDetector(PNeXusDetector2 &detector) { fDetector = detector; }
private:
string fName; ///< name of the instrument
PNeXusSource2 fSource; ///< details of the muon source used
PNeXusBeamline2 fBeamline; ///< beamline description
PNeXusDetector2 fDetector; ///< details of the detectors which also includes the data!!
};
class PNeXusSample2 {
public:
PNeXusSample2();
virtual ~PNeXusSample2();
virtual bool IsValid(bool strict);
virtual string GetName() { return fName; }
virtual string GetDescription() { return fDescription; }
virtual string GetMagneticFieldState() { return fMagneticFieldState; }
virtual string GetEnvironmentTemp() { return fEnvironmentTemp; }
virtual string GetEnvironmentField() { return fEnvironmentField; }
virtual double GetPhysPropValue(string name, bool &ok);
virtual void GetPhysPropUnit(string name, string &unit, bool &ok);
virtual void SetName(string name) { fName = name; }
virtual void SetDescription(string description) { fDescription = description; }
virtual void SetMagneticFieldState(string magFieldState) { fMagneticFieldState = magFieldState; }
virtual void SetEnvironmentTemp(string env) { fEnvironmentTemp = env; }
virtual void SetEnvironmentField(string env) { fEnvironmentField = env; }
virtual void SetPhysProp(string name, double value, string unit, int idx=-1);
private:
string fName; ///< sample name
string fDescription; ///< sample description
string fMagneticFieldState; ///< magnetic field state, e.g. TF, ZF, ...
string fEnvironmentTemp; ///< sample environment related to temperature, e.g. CCR, Konti-1, ...
string fEnvironmentField; ///< sample environment related to field, e.g. WEW-Bruker
vector<PNeXusProp> fPhysProp; ///< collects the temperature, magnetic field
};
class PNeXusUser2 {
public:
PNeXusUser2() { fName = "n/a"; }
virtual ~PNeXusUser2() {}
virtual bool IsValid(bool strict) { return true; } // currently only a dummy
virtual string GetName() { return fName; }
virtual void SetName(string name) { fName = name; }
private:
string fName; ///< user name
};
class PNeXusEntry2 {
public:
PNeXusEntry2();
virtual ~PNeXusEntry2() {}
virtual bool IsValid(bool strict);
virtual string GetDefinition() { return fDefinition; }
virtual string GetProgramName() { return fProgramName; }
virtual string GetProgramVersion() { return fProgramVersion; }
virtual int GetRunNumber() { return fRunNumber; }
virtual string GetTitle() { return fTitle; }
virtual string GetStartTime() { return fStartTime; }
virtual string GetStopTime() { return fStopTime; }
virtual string GetExperimentIdentifier() { return fExperimentIdentifier; }
virtual PNeXusUser2* GetUser() { return &fUser; }
virtual PNeXusSample2* GetSample() { return &fSample; }
virtual PNeXusInstrument2* GetInstrument() { return &fInstrument; }
virtual void SetDefinition(string def) { fDefinition = def; }
virtual void SetProgramName(string name) { fProgramName = name; }
virtual void SetProgramVersion(string version) { fProgramVersion = version; }
virtual void SetRunNumber(int number) { fRunNumber = number; }
virtual void SetTitle(string title) { fTitle = title; }
virtual int SetStartTime(string time);
virtual int SetStopTime(string time);
virtual void SetExperimentIdentifier(string expId) { fExperimentIdentifier = expId; }
virtual void SetUser(PNeXusUser2 &user) { fUser = user; }
virtual void SetSample(PNeXusSample2 &sample) { fSample = sample; }
virtual void SetInstrument(PNeXusInstrument2 &instrument) { fInstrument = instrument; }
private:
string fDefinition; ///< the template (DTD name) on which the entry was based, e.g. 'pulsedTD'
string fProgramName; ///< name of the creating program
string fProgramVersion; ///< version of the creating program
int fRunNumber; ///< run number
string fTitle; ///< string containing the run title
string fStartTime; ///< start date/time of the run
string fStopTime; ///< stop date/time of the run
string fExperimentIdentifier; ///< experiment number, (for ISIS, the RB number)
PNeXusUser2 fUser; ///< NXuser info IDF Version 2
PNeXusSample2 fSample; ///< NXsample info IDF Version 2
PNeXusInstrument2 fInstrument; ///< NXinstrument inf IDF Version 2
};
//-----------------------------------------------------------------------------
/**
*
*/
class PNeXus {
public:
PNeXus();
PNeXus(const char* fileName);
virtual ~PNeXus();
virtual bool IsValid() { return fIsValid; }
virtual int GetIdfVersion() { return fIdfVersion; }
virtual string GetFileName() { return fFileName; }
virtual string GetFileTime() { return fFileTime; }
virtual void SetIdfVersion(unsigned int idf);
virtual void SetFileName(string name) { fFileName = name; }
virtual void SetFileTime(string time) { fFileTime = time; }
virtual PNeXusEntry1* GetEntryIdf1() { return fNxEntry1; }
virtual PNeXusEntry2* GetEntryIdf2() { return fNxEntry2; }
virtual bool IsValid(bool strict=false);
virtual int GetErrorCode() { return fErrorCode; }
virtual string GetErrorMsg() { return fErrorMsg; }
virtual vector<unsigned int>* GetGroupedHisto(unsigned int idx);
virtual int ReadFile(const char *fileName);
virtual int WriteFile(const char *fileName, const char *fileType="hdf4");
virtual int WriteFile(const char *fileName, const char *fileType="hdf4", const unsigned int idf=2);
virtual void SetCreator(string str) { fCreator = str; }
virtual void Dump();
virtual int GetErrorCode() { return fErrorCode; }
virtual string GetErrorMsg() { return fErrorMsg; }
virtual string GetFileName() { return fFileName; }
virtual int GetIDFVersion() { return fIDFVersion; }
virtual string GetProgramName() { return fProgramName; }
virtual string GetProgramVersion() { return fProgramVersion; }
virtual int GetRunNumber() { return fRunNumber; }
virtual string GetRunTitle() { return fRunTitle; }
virtual string GetRunNotes() { return fNotes; }
virtual string GetAnalysisTag() { return fAnalysisTag; }
virtual string GetLab() { return fLab; }
virtual string GetBeamline() { return fBeamLine; }
virtual string GetStartDate() { return fStartDate; }
virtual string GetStartTime() { return fStartTime; }
virtual string GetStopDate() { return fStopDate; }
virtual string GetStopTime() { return fStopTime; }
virtual int GetSwitchingState() { return fSwitchingState; }
virtual string GetUser() { return fUser.fUserName; }
virtual string GetExperimentNumber() { return fUser.fExperimentNumber; }
virtual string GetSampleName() { return fSample.fName; }
virtual double GetSampleTemperature() { return fSample.fTemperature; }
virtual string GetSampleTemperartureUnits() { return fSample.fTemperatureUnit; }
virtual double GetMagneticField() { return fSample.fMagneticField; }
virtual string GetMagneticFieldUnits() { return fSample.fMagneticFieldUnit; }
virtual string GetMagneticFieldState() { return fSample.fMagneticFieldState; }
virtual int IsMagneticFieldVectorAvailable() { return fSample.fMagneticFieldVectorAvailable; }
virtual vector<double>& GetMagneticFieldVector() { return fSample.fMagneticFieldVector; }
virtual string GetMagneticFieldVectorCoordSystem() { return fSample.fMagneticFieldVectorCoordinateSystem; }
virtual string GetMagneticFieldVectorUnits() { return fSample.fMagneticFieldVectorUnits; }
virtual string GetSampleEnvironment() { return fSample.fEnvironment; }
virtual string GetSampleShape() { return fSample.fShape; }
virtual string GetExperimentName() { return fInstrument.name; }
virtual int GetNoDetectors() { return fInstrument.detector.number; }
virtual string GetCollimatorType() { return fInstrument.collimator.type; }
virtual double GetTotalNoEvents() { return fInstrument.beam.total_counts; }
virtual string GetTotalNoEventsUnits() { return fInstrument.beam.total_counts_units; }
virtual double GetTimeResolution() { return fData.fTimeResolution; }
virtual int GetNoHistos() { return fData.fNumberOfHistos; }
virtual int IsAlphaAvailable() { return fData.fAlpha.size(); }
virtual vector<PNeXusAlpha> *GetAlpha() { if (fData.fAlpha.size()) return &fData.fAlpha; else return 0; }
virtual unsigned int GetT0() { if (fData.fT0.size()) return fData.fT0[0]; else return 0; }
virtual unsigned int GetFirstGoodBin() { if (fData.fFirstGoodBin.size()) return fData.fFirstGoodBin[0]; else return 0; }
virtual unsigned int GetLastGoodBin() { if (fData.fLastGoodBin.size()) return fData.fLastGoodBin[0]; else return 0; }
virtual vector<unsigned int> *GetHisto(unsigned int histoNo) { if (fData.fHisto.size() > histoNo) return &fData.fHisto[histoNo]; else return 0;}
virtual vector<unsigned int> *GetGroupedHisto(unsigned int histoNo) { if (fGroupedData.size() > histoNo) return &fGroupedData[histoNo]; else return 0; }
virtual void SetFileName(const char* fileName) { fFileName = fileName; }
virtual void SetFileName(string fileName) { fFileName = fileName; }
virtual void SetIDFVersion(int idfVersion) { fIDFVersion = idfVersion; }
virtual void SetProgramName(const char* progName) { fProgramName = progName; }
virtual void SetProgramName(string progName) { fProgramName = progName; }
virtual void SetProgramVersion(const char* progVersion) { fProgramVersion = progVersion; }
virtual void SetProgramVersion(string progVersion) { fProgramVersion = progVersion; }
virtual void SetRunNumber(int runNumber) { fRunNumber = runNumber; }
virtual void SetRunTitle(const char* runTitle) { fRunTitle = runTitle; }
virtual void SetRunTitle(string runTitle) { fRunTitle = runTitle; }
virtual void SetRunNotes(const char* notes) { fNotes = notes; }
virtual void SetRunNotes(string notes) { fNotes = notes; }
virtual void SetAnalysisTag(const char* analysisTag) { fAnalysisTag = analysisTag; }
virtual void SetAnalysisTag(string analysisTag) { fAnalysisTag = analysisTag; }
virtual void SetLab(const char *lab) { fLab = lab; }
virtual void SetLab(string lab) { fLab = lab; }
virtual void SetBeamline(const char *beamline) { fBeamLine = beamline; }
virtual void SetBeamline(string beamline) { fBeamLine = beamline; }
virtual bool SetStartDate(const char *date);
virtual bool SetStartDate(string date);
virtual bool SetStartTime(const char *time);
virtual bool SetStartTime(string time);
virtual bool SetStopDate(const char *date);
virtual bool SetStopDate(string date);
virtual bool SetStopTime(const char *time);
virtual bool SetStopTime(string time);
virtual void SetSwitchingState(int state) { fSwitchingState=state; }
virtual void SetUser(string user) { fUser.fUserName = user; }
virtual void SetExperimentNumber(string number) { fUser.fExperimentNumber = number; }
virtual void SetSampleName(string name) { fSample.fName = name; }
virtual void SetSampleTemperature(double temp) { fSample.fTemperature = temp; }
virtual void SetSampleTemperatureUints(string units) { fSample.fTemperatureUnit = units; }
virtual void SetMagneticField(double field) { fSample.fMagneticField = field; }
virtual void SetMagneticFieldUnits(string units) { fSample.fMagneticFieldUnit = units; }
virtual void SetMagneticFieldState(string state) { fSample.fMagneticFieldState = state; }
virtual void SetSampleEnvironment(string env) { fSample.fEnvironment = env; }
virtual void SetSampleShape(string shape) { fSample.fShape = shape; }
virtual void SetMagneticFieldVectorAvailable(int available) { fSample.fMagneticFieldVectorAvailable = available; }
virtual void SetMagneticFieldVector(vector<double>& vec) {fSample.fMagneticFieldVectorAvailable = 1; fSample.fMagneticFieldVector = vec;}
virtual void SetMagneticFieldVectorCoordSystem(string coord) { fSample.fMagneticFieldVectorCoordinateSystem = coord; }
virtual void SetMagneticFieldVectorUnits(string units) { fSample.fMagneticFieldVectorUnits = units; }
virtual void SetExperimentName(string name) { fInstrument.name = name; }
virtual void SetNoDetectors(unsigned int no) { fInstrument.detector.number = no; }
virtual void SetCollimatorType(string type) { fInstrument.collimator.type = type; }
virtual void SetTimeResolution(double timeResolution) { fData.fTimeResolution = timeResolution; } // given in ns
virtual void SetT0(unsigned int t0, unsigned int idx=0);
virtual void SetFirstGoodBin(unsigned int fgb, unsigned int idx=0);
virtual void SetLastGoodBin(unsigned int lgb, unsigned int idx=0);
virtual void SetHisto(unsigned int histoNo, vector<unsigned int> &data);
private:
bool fIsValid;
string fFileName; ///< read/write file name
NXhandle fFileHandle; ///< nexus file handle
bool fValid;
int fErrorCode;
string fErrorMsg;
string fErrorMsg; ///< stores the current error message
int fErrorCode; ///< indicates the current error code
string fNeXusVersion; ///< version of the NeXus API used in writing the file
string fFileFormatVersion; ///< version of the HDF, HDF5, or XML library used to create the file (IDF 2 only)
int fIDFVersion;
string fProgramName;
string fProgramVersion;
unsigned int fIdfVersion; ///< version of the instrument definition
string fFileName; ///< file name of the original NeXus file to assist identification if the external name has been changed
string fFileTime; ///< date and time of file creating (IDF 2 only)
NXhandle fFileHandle;
int fRunNumber;
string fRunTitle;
string fNotes;
string fAnalysisTag; ///< type of muon experiment
string fLab;
string fBeamLine;
string fStartDate;
string fStartTime;
string fStopDate;
string fStopTime;
int fSwitchingState; ///< red/green mode
string fCreator; ///< facility of program where the file originated
PNeXusUser fUser;
PNeXusSample fSample;
PNeXusInstrument fInstrument;
PNeXusData fData;
vector< vector<unsigned int> > fGroupedData;
PNeXusEntry1 *fNxEntry1; ///< NXentry for IDF 1
PNeXusEntry2 *fNxEntry2; ///< NXentry for IDF 2
vector< vector<unsigned int> > fGroupedHisto;
virtual void Init();
virtual void CleanUp();
virtual bool ErrorHandler(NXstatus status, int errCode, const string &errMsg);
virtual NXstatus GetStringData(string &str);
virtual NXstatus GetStringAttr(string attr, string &str);
virtual int GetDataSize(int type);
virtual NXstatus GetDoubleVectorData(vector<double> &data);
virtual NXstatus GetIntVectorData(vector<int> &data);
virtual int ReadFileIdf1();
virtual int ReadFileIdf2();
virtual int WriteFileIdf1(const char* fileName, const NXaccess access);
virtual int WriteFileIdf2(const char* fileName, const NXaccess access);
virtual NXstatus GroupHistoData();
virtual string TransformDate(string date, bool &ok);
virtual int GetMonth(const string month);
virtual bool IsValidIdf1(bool strict);
virtual bool IsValidIdf2(bool strict);
virtual bool SearchInGroup(string str, string tag, NXname &nxname, NXname &nxclass, int &dataType);
};
#endif // _PNEXUS_H_