Skip to content

Commit

Permalink
Refs #9445. Fixing some style problems
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Wedel committed Jul 8, 2014
1 parent 19fb420 commit dc06bbb
Show file tree
Hide file tree
Showing 8 changed files with 59 additions and 57 deletions.
Expand Up @@ -85,8 +85,8 @@ class VectorDoubleValueExtractor : public AbstractDoubleValueExtractor
class MANTID_SINQ_DLL PoldiInstrumentAdapter
{
public:
PoldiInstrumentAdapter(API::MatrixWorkspace_const_sptr matrixWorkspace);
PoldiInstrumentAdapter(Geometry::Instrument_const_sptr mantidInstrument, const API::Run &runInformation);
PoldiInstrumentAdapter(const API::MatrixWorkspace_const_sptr &matrixWorkspace);
PoldiInstrumentAdapter(const Geometry::Instrument_const_sptr &mantidInstrument, const API::Run &runInformation);
virtual ~PoldiInstrumentAdapter();

PoldiAbstractChopper_sptr chopper() const;
Expand All @@ -96,11 +96,11 @@ class MANTID_SINQ_DLL PoldiInstrumentAdapter
protected:
PoldiInstrumentAdapter() { }

void initializeFromInstrumentAndRun(Geometry::Instrument_const_sptr mantidInstrument, const API::Run &runInformation);
void initializeFromInstrumentAndRun(const Geometry::Instrument_const_sptr &mantidInstrument, const API::Run &runInformation);

void setDetector(Geometry::Instrument_const_sptr mantidInstrument);
void setChopper(Geometry::Instrument_const_sptr mantidInstrument, const API::Run &runInformation);
void setSpectrum(Geometry::Instrument_const_sptr mantidInstrument);
void setDetector(const Geometry::Instrument_const_sptr &mantidInstrument);
void setChopper(const Geometry::Instrument_const_sptr &mantidInstrument, const API::Run &runInformation);
void setSpectrum(const Geometry::Instrument_const_sptr &mantidInstrument);

double getChopperSpeedFromRun(const API::Run &runInformation);
AbstractDoubleValueExtractor_sptr getExtractorForProperty(Kernel::Property *chopperSpeedProperty);
Expand Down
Expand Up @@ -51,14 +51,14 @@ class MANTID_SINQ_DLL PoldiPeakCollection
};

PoldiPeakCollection(IntensityType intensityType = Maximum);
PoldiPeakCollection(DataObjects::TableWorkspace_sptr workspace);
PoldiPeakCollection(const DataObjects::TableWorkspace_sptr &workspace);
virtual ~PoldiPeakCollection() {}

PoldiPeakCollection_sptr clone();

size_t peakCount() const;

void addPeak(PoldiPeak_sptr newPeak);
void addPeak(const PoldiPeak_sptr &newPeak);
PoldiPeak_sptr peak(size_t index) const;

IntensityType intensityType() const;
Expand All @@ -70,19 +70,19 @@ class MANTID_SINQ_DLL PoldiPeakCollection
DataObjects::TableWorkspace_sptr asTableWorkspace();

protected:
void prepareTable(DataObjects::TableWorkspace_sptr table);
void dataToTableLog(DataObjects::TableWorkspace_sptr table);
void peaksToTable(DataObjects::TableWorkspace_sptr table);
void prepareTable(const DataObjects::TableWorkspace_sptr &table);
void dataToTableLog(const DataObjects::TableWorkspace_sptr &table);
void peaksToTable(const DataObjects::TableWorkspace_sptr &table);

void constructFromTableWorkspace(DataObjects::TableWorkspace_sptr tableWorkspace);
bool checkColumns(DataObjects::TableWorkspace_sptr tableWorkspace);
void constructFromTableWorkspace(const DataObjects::TableWorkspace_sptr &tableWorkspace);
bool checkColumns(const DataObjects::TableWorkspace_sptr &tableWorkspace);

void recoverDataFromLog(DataObjects::TableWorkspace_sptr TableWorkspace);
void recoverDataFromLog(const DataObjects::TableWorkspace_sptr &TableWorkspace);

std::string getIntensityTypeFromLog(API::LogManager_sptr tableLog);
std::string getProfileFunctionNameFromLog(API::LogManager_sptr tableLog);
std::string getIntensityTypeFromLog(const API::LogManager_sptr &tableLog);
std::string getProfileFunctionNameFromLog(const API::LogManager_sptr &tableLog);

std::string getStringValueFromLog(API::LogManager_sptr logManager, std::string valueName);
std::string getStringValueFromLog(const API::LogManager_sptr &logManager, std::string valueName);

std::string intensityTypeToString(IntensityType type) const;
IntensityType intensityTypeFromString(std::string typeString) const;
Expand Down
Expand Up @@ -55,9 +55,9 @@ class MANTID_SINQ_DLL PoldiSpectrumDomainFunction : virtual public API::ParamFun

protected:
virtual void init();
void initializeParametersFromWorkspace(DataObjects::Workspace2D_const_sptr workspace2D);
void initializeInstrumentParameters(PoldiInstrumentAdapter_sptr poldiInstrument);
std::vector<double> getChopperSlitOffsets(PoldiAbstractChopper_sptr chopper);
void initializeParametersFromWorkspace(const DataObjects::Workspace2D_const_sptr &workspace2D);
void initializeInstrumentParameters(const PoldiInstrumentAdapter_sptr &poldiInstrument);
std::vector<double> getChopperSlitOffsets(const PoldiAbstractChopper_sptr &chopper);

double actualFunction(double x, double x0, double sigma, double area) const;

Expand Down
Expand Up @@ -44,7 +44,7 @@ struct DetectorElementCharacteristics {
DetectorElementCharacteristics()
{ }

DetectorElementCharacteristics(int element, PoldiAbstractDetector_sptr detector, PoldiAbstractChopper_sptr chopper)
DetectorElementCharacteristics(int element, const PoldiAbstractDetector_sptr &detector, const PoldiAbstractChopper_sptr &chopper)
{
distance = detector->distanceFromSample(element);
totalDistance = detector->distanceFromSample(element) + chopper->distanceFromSample();
Expand All @@ -65,7 +65,7 @@ struct DetectorElementCharacteristics {
class DetectorElementData
{
public:
DetectorElementData(int element, DetectorElementCharacteristics center, PoldiAbstractDetector_sptr detector, PoldiAbstractChopper_sptr chopper)
DetectorElementData(int element, const DetectorElementCharacteristics &center, const PoldiAbstractDetector_sptr &detector, const PoldiAbstractChopper_sptr &chopper)
{
DetectorElementCharacteristics current(element, detector, chopper);

Expand Down Expand Up @@ -93,10 +93,10 @@ class MANTID_SINQ_DLL PoldiTimeTransformer
{
public:
PoldiTimeTransformer();
PoldiTimeTransformer(PoldiInstrumentAdapter_sptr poldiInstrument);
PoldiTimeTransformer(const PoldiInstrumentAdapter_sptr &poldiInstrument);
virtual ~PoldiTimeTransformer() { }

void initializeFromPoldiInstrument(PoldiInstrumentAdapter_sptr poldiInstrument);
void initializeFromPoldiInstrument(const PoldiInstrumentAdapter_sptr &poldiInstrument);

size_t detectorElementCount() const;

Expand All @@ -109,8 +109,8 @@ class MANTID_SINQ_DLL PoldiTimeTransformer
double calculatedTotalIntensity(double centreD) const;

protected:
std::vector<DetectorElementData_const_sptr> getDetectorElementData(PoldiAbstractDetector_sptr detector, PoldiAbstractChopper_sptr chopper);
DetectorElementCharacteristics getDetectorCenterCharacteristics(PoldiAbstractDetector_sptr detector, PoldiAbstractChopper_sptr chopper);
std::vector<DetectorElementData_const_sptr> getDetectorElementData(const PoldiAbstractDetector_sptr &detector, const PoldiAbstractChopper_sptr &chopper);
DetectorElementCharacteristics getDetectorCenterCharacteristics(const PoldiAbstractDetector_sptr &detector, const PoldiAbstractChopper_sptr &chopper);

DetectorElementCharacteristics m_detectorCenter;
std::vector<DetectorElementData_const_sptr> m_detectorElementData;
Expand Down
Expand Up @@ -5,6 +5,7 @@
#include "MantidSINQ/PoldiUtilities/PoldiSourceSpectrum.h"

#include "boost/assign.hpp"
#include "boost/make_shared.hpp"

namespace Mantid
{
Expand All @@ -18,16 +19,16 @@ const std::string PoldiInstrumentAdapter::m_chopperSpeedPropertyName = "choppers

std::map<std::string, AbstractDoubleValueExtractor_sptr> PoldiInstrumentAdapter::m_extractors =
boost::assign::map_list_of
("dbl list", AbstractDoubleValueExtractor_sptr(new VectorDoubleValueExtractor(PoldiInstrumentAdapter::m_chopperSpeedPropertyName)))
("number", AbstractDoubleValueExtractor_sptr(new NumberDoubleValueExtractor(PoldiInstrumentAdapter::m_chopperSpeedPropertyName)));
("dbl list", boost::static_pointer_cast<AbstractDoubleValueExtractor>(boost::make_shared<VectorDoubleValueExtractor>(PoldiInstrumentAdapter::m_chopperSpeedPropertyName)))
("number", boost::static_pointer_cast<AbstractDoubleValueExtractor>(boost::make_shared<NumberDoubleValueExtractor>(PoldiInstrumentAdapter::m_chopperSpeedPropertyName)));

/** Constructor with workspace argument
*
* This constructor directly takes a matrix workspace and extracts instrument and run information.
*
* @param matrixWorkspace :: Workspace with a valid POLDI instrument and run information
*/
PoldiInstrumentAdapter::PoldiInstrumentAdapter(API::MatrixWorkspace_const_sptr matrixWorkspace)
PoldiInstrumentAdapter::PoldiInstrumentAdapter(const MatrixWorkspace_const_sptr &matrixWorkspace)
{
initializeFromInstrumentAndRun(matrixWorkspace->getInstrument(), matrixWorkspace->run());
}
Expand All @@ -39,7 +40,7 @@ PoldiInstrumentAdapter::PoldiInstrumentAdapter(API::MatrixWorkspace_const_sptr m
* @param mantidInstrument :: Const shared pointer to Mantid::Geometry::Instrument
* @param runInformation :: Const Reference to Mantid::API::Run object
*/
PoldiInstrumentAdapter::PoldiInstrumentAdapter(Instrument_const_sptr mantidInstrument, const Run &runInformation)
PoldiInstrumentAdapter::PoldiInstrumentAdapter(const Instrument_const_sptr &mantidInstrument, const Run &runInformation)
{
initializeFromInstrumentAndRun(mantidInstrument, runInformation);
}
Expand Down Expand Up @@ -85,7 +86,7 @@ PoldiSourceSpectrum_sptr PoldiInstrumentAdapter::spectrum() const
* @param mantidInstrument :: Const shared pointer to Mantid::Geometry::Instrument
* @param runInformation :: Const Reference to Mantid::API::Run object
*/
void PoldiInstrumentAdapter::initializeFromInstrumentAndRun(Instrument_const_sptr mantidInstrument, const Run &runInformation)
void PoldiInstrumentAdapter::initializeFromInstrumentAndRun(const Instrument_const_sptr &mantidInstrument, const Run &runInformation)
{
if(!mantidInstrument) {
throw std::runtime_error("Can not construct POLDI classes from invalid instrument. Aborting.");
Expand All @@ -104,7 +105,7 @@ void PoldiInstrumentAdapter::initializeFromInstrumentAndRun(Instrument_const_spt
*
* @param mantidInstrument :: Mantid instrument with POLDI detector setup data.
*/
void PoldiInstrumentAdapter::setDetector(Instrument_const_sptr mantidInstrument)
void PoldiInstrumentAdapter::setDetector(const Instrument_const_sptr &mantidInstrument)
{
PoldiDetectorFactory detectorFactory;
m_detector = PoldiAbstractDetector_sptr(detectorFactory.createDetector(std::string("helium3-detector")));
Expand All @@ -119,7 +120,7 @@ void PoldiInstrumentAdapter::setDetector(Instrument_const_sptr mantidInstrument)
* @param mantidInstrument :: Mantid instrument with POLDI chopper information.
* @param runInformation :: Run information that contains a "chopperspeed" property.
*/
void PoldiInstrumentAdapter::setChopper(Instrument_const_sptr mantidInstrument, const Run &runInformation)
void PoldiInstrumentAdapter::setChopper(const Instrument_const_sptr &mantidInstrument, const Run &runInformation)
{
double chopperSpeed = getChopperSpeedFromRun(runInformation);

Expand Down Expand Up @@ -182,9 +183,9 @@ AbstractDoubleValueExtractor_sptr PoldiInstrumentAdapter::getExtractorForPropert
*
* @param mantidInstrument :: Mantid instrument containing a lookup table with a neutron wavelength spectrum.
*/
void PoldiInstrumentAdapter::setSpectrum(Instrument_const_sptr mantidInstrument)
void PoldiInstrumentAdapter::setSpectrum(const Instrument_const_sptr &mantidInstrument)
{
m_spectrum = PoldiSourceSpectrum_sptr(new PoldiSourceSpectrum(mantidInstrument));
m_spectrum = boost::make_shared<PoldiSourceSpectrum>(mantidInstrument);
}

} // namespace Poldi
Expand Down
Expand Up @@ -21,7 +21,7 @@ PoldiPeakCollection::PoldiPeakCollection(IntensityType intensityType) :
{
}

PoldiPeakCollection::PoldiPeakCollection(TableWorkspace_sptr workspace) :
PoldiPeakCollection::PoldiPeakCollection(const TableWorkspace_sptr &workspace) :
m_peaks()
{
if(workspace) {
Expand All @@ -31,7 +31,7 @@ PoldiPeakCollection::PoldiPeakCollection(TableWorkspace_sptr workspace) :

PoldiPeakCollection_sptr PoldiPeakCollection::clone()
{
PoldiPeakCollection_sptr clone(new PoldiPeakCollection(m_intensityType));
PoldiPeakCollection_sptr clone = boost::make_shared<PoldiPeakCollection>(m_intensityType);
clone->setProfileFunctionName(m_profileFunctionName);

for(size_t i = 0; i < m_peaks.size(); ++i) {
Expand All @@ -46,7 +46,7 @@ size_t PoldiPeakCollection::peakCount() const
return m_peaks.size();
}

void PoldiPeakCollection::addPeak(PoldiPeak_sptr newPeak)
void PoldiPeakCollection::addPeak(const PoldiPeak_sptr &newPeak)
{
m_peaks.push_back(newPeak);
}
Expand Down Expand Up @@ -91,7 +91,7 @@ TableWorkspace_sptr PoldiPeakCollection::asTableWorkspace()
return peaks;
}

void PoldiPeakCollection::prepareTable(TableWorkspace_sptr table)
void PoldiPeakCollection::prepareTable(const TableWorkspace_sptr &table)
{
table->addColumn("str", "HKL");
table->addColumn("str", "d");
Expand All @@ -100,14 +100,14 @@ void PoldiPeakCollection::prepareTable(TableWorkspace_sptr table)
table->addColumn("str", "FWHM (rel.)");
}

void PoldiPeakCollection::dataToTableLog(TableWorkspace_sptr table)
void PoldiPeakCollection::dataToTableLog(const TableWorkspace_sptr &table)
{
LogManager_sptr tableLog = table->logs();
tableLog->addProperty<std::string>("IntensityType", intensityTypeToString(m_intensityType));
tableLog->addProperty<std::string>("ProfileFunctionName", m_profileFunctionName);
}

void PoldiPeakCollection::peaksToTable(TableWorkspace_sptr table)
void PoldiPeakCollection::peaksToTable(const TableWorkspace_sptr &table)
{
for(std::vector<PoldiPeak_sptr>::const_iterator peak = m_peaks.begin(); peak != m_peaks.end(); ++peak) {
TableRow newRow = table->appendRow();
Expand All @@ -119,7 +119,7 @@ void PoldiPeakCollection::peaksToTable(TableWorkspace_sptr table)
}
}

void PoldiPeakCollection::constructFromTableWorkspace(TableWorkspace_sptr tableWorkspace)
void PoldiPeakCollection::constructFromTableWorkspace(const TableWorkspace_sptr &tableWorkspace)
{
if(checkColumns(tableWorkspace)) {
size_t newPeakCount = tableWorkspace->rowCount();
Expand All @@ -141,7 +141,7 @@ void PoldiPeakCollection::constructFromTableWorkspace(TableWorkspace_sptr tableW
}
}

bool PoldiPeakCollection::checkColumns(TableWorkspace_sptr tableWorkspace)
bool PoldiPeakCollection::checkColumns(const TableWorkspace_sptr &tableWorkspace)
{
if(tableWorkspace->columnCount() != 5) {
return false;
Expand All @@ -159,25 +159,25 @@ bool PoldiPeakCollection::checkColumns(TableWorkspace_sptr tableWorkspace)
return columnNames == shouldNames;
}

void PoldiPeakCollection::recoverDataFromLog(TableWorkspace_sptr tableWorkspace)
void PoldiPeakCollection::recoverDataFromLog(const TableWorkspace_sptr &tableWorkspace)
{
LogManager_sptr tableLog = tableWorkspace->logs();

m_intensityType = intensityTypeFromString(getIntensityTypeFromLog(tableLog));
m_profileFunctionName = getProfileFunctionNameFromLog(tableLog);
}

std::string PoldiPeakCollection::getIntensityTypeFromLog(LogManager_sptr tableLog)
std::string PoldiPeakCollection::getIntensityTypeFromLog(const LogManager_sptr &tableLog)
{
return getStringValueFromLog(tableLog, "IntensityType");
}

std::string PoldiPeakCollection::getProfileFunctionNameFromLog(LogManager_sptr tableLog)
std::string PoldiPeakCollection::getProfileFunctionNameFromLog(const LogManager_sptr &tableLog)
{
return getStringValueFromLog(tableLog, "ProfileFunctionName");
}

std::string PoldiPeakCollection::getStringValueFromLog(LogManager_sptr logManager, std::string valueName)
std::string PoldiPeakCollection::getStringValueFromLog(const LogManager_sptr &logManager, std::string valueName)
{
if(logManager->hasProperty(valueName)) {
return logManager->getPropertyValueAsType<std::string>(valueName);
Expand Down
Expand Up @@ -120,11 +120,11 @@ void PoldiSpectrumDomainFunction::init() {
*
* @param workspace2D :: Workspace with valid POLDI instrument and required run information
*/
void PoldiSpectrumDomainFunction::initializeParametersFromWorkspace(Workspace2D_const_sptr workspace2D)
void PoldiSpectrumDomainFunction::initializeParametersFromWorkspace(const Workspace2D_const_sptr &workspace2D)
{
m_deltaT = workspace2D->readX(0)[1] - workspace2D->readX(0)[0];

PoldiInstrumentAdapter_sptr adapter(new PoldiInstrumentAdapter(workspace2D->getInstrument(), workspace2D->run()));
PoldiInstrumentAdapter_sptr adapter = boost::make_shared<PoldiInstrumentAdapter>(workspace2D->getInstrument(), workspace2D->run());
initializeInstrumentParameters(adapter);
}

Expand All @@ -136,9 +136,9 @@ void PoldiSpectrumDomainFunction::initializeParametersFromWorkspace(Workspace2D_
*
* @param poldiInstrument :: PoldiInstrumentAdapter that holds chopper, detector and spectrum
*/
void PoldiSpectrumDomainFunction::initializeInstrumentParameters(PoldiInstrumentAdapter_sptr poldiInstrument)
void PoldiSpectrumDomainFunction::initializeInstrumentParameters(const PoldiInstrumentAdapter_sptr &poldiInstrument)
{
m_timeTransformer = PoldiTimeTransformer_sptr(new PoldiTimeTransformer(poldiInstrument));
m_timeTransformer = boost::make_shared<PoldiTimeTransformer>(poldiInstrument);
m_chopperSlitOffsets = getChopperSlitOffsets(poldiInstrument->chopper());

}
Expand All @@ -149,7 +149,7 @@ void PoldiSpectrumDomainFunction::initializeInstrumentParameters(PoldiInstrument
* @param chopper :: PoldiAbstractChopper with slit times, not corrected with zero-offset
* @return vector with zero-offset-corrected chopper slit times
*/
std::vector<double> PoldiSpectrumDomainFunction::getChopperSlitOffsets(PoldiAbstractChopper_sptr chopper)
std::vector<double> PoldiSpectrumDomainFunction::getChopperSlitOffsets(const PoldiAbstractChopper_sptr &chopper)
{
const std::vector<double> &chopperSlitTimes = chopper->slitTimes();
std::vector<double> offsets;
Expand Down
@@ -1,4 +1,5 @@
#include "MantidSINQ/PoldiUtilities/PoldiTimeTransformer.h"
#include "boost/make_shared.hpp"

namespace Mantid
{
Expand All @@ -14,12 +15,12 @@ PoldiTimeTransformer::PoldiTimeTransformer() :
{
}

PoldiTimeTransformer::PoldiTimeTransformer(PoldiInstrumentAdapter_sptr poldiInstrument)
PoldiTimeTransformer::PoldiTimeTransformer(const PoldiInstrumentAdapter_sptr &poldiInstrument)
{
initializeFromPoldiInstrument(poldiInstrument);
}

void PoldiTimeTransformer::initializeFromPoldiInstrument(PoldiInstrumentAdapter_sptr poldiInstrument)
void PoldiTimeTransformer::initializeFromPoldiInstrument(const PoldiInstrumentAdapter_sptr &poldiInstrument)
{
if(!poldiInstrument) {
throw std::invalid_argument("Cannot initialize PoldiTimeTransformer from null-instrument.");
Expand Down Expand Up @@ -84,20 +85,20 @@ size_t PoldiTimeTransformer::detectorElementCount() const
return m_detectorElementData.size();
}

std::vector<DetectorElementData_const_sptr> PoldiTimeTransformer::getDetectorElementData(PoldiAbstractDetector_sptr detector, PoldiAbstractChopper_sptr chopper)
std::vector<DetectorElementData_const_sptr> PoldiTimeTransformer::getDetectorElementData(const PoldiAbstractDetector_sptr &detector, const PoldiAbstractChopper_sptr &chopper)
{
std::vector<DetectorElementData_const_sptr> data(detector->elementCount());

DetectorElementCharacteristics center = getDetectorCenterCharacteristics(detector, chopper);

for(int i = 0; i < static_cast<int>(detector->elementCount()); ++i) {
data[i] = DetectorElementData_const_sptr(new DetectorElementData(i, center, detector, chopper));
data[i] = boost::make_shared<DetectorElementData>(i, center, detector, chopper);
}

return data;
}

DetectorElementCharacteristics PoldiTimeTransformer::getDetectorCenterCharacteristics(PoldiAbstractDetector_sptr detector, PoldiAbstractChopper_sptr chopper)
DetectorElementCharacteristics PoldiTimeTransformer::getDetectorCenterCharacteristics(const PoldiAbstractDetector_sptr &detector, const PoldiAbstractChopper_sptr &chopper)
{
return DetectorElementCharacteristics(static_cast<int>(detector->centralElement()), detector, chopper);
}
Expand Down

0 comments on commit dc06bbb

Please sign in to comment.