Mantid Namespace Reference

XML Parser for parameter types for ImplicitFunctions. More...

Namespaces

namespace  Algorithms
namespace  API
namespace  Crystal
namespace  CurveFitting
namespace  DataHandling
namespace  DataObjects
namespace  Geometry
 

Forward Declarations;.


namespace  ICat
namespace  Kernel
namespace  mathLevel
namespace  mathSupport
namespace  MDAlgorithms
namespace  MDEvents
namespace  NeXus
namespace  PhysicalConstants
 

A namespace containing physical constants that are required by algorithms and unit routines.


namespace  PythonAPI
namespace  PythonInterface
namespace  Vates
namespace  VATES
namespace  WorkflowAlgorithms

Classes

class  DTriple
 Triple of three different things. More...
class  NoDeleting
 An object for constructing a shared_ptr that won't ever delete its pointee. More...
class  TestChannel
class  Triple
 Triple of three identical types. More...

Typedefs

typedef float coord_t
 Typedef for the data type to use for coordinate axes in MD objects such as MDBox, MDEventWorkspace, etc.
typedef std::map< detid_t,
Geometry::IDetector_const_sptr > 		detid2det_map
 Typedef of a map from detector ID to detector shared pointer.
typedef std::map< detid_t, size_t > detid2index_map
 Map with key = detector ID, value = workspace index.
typedef int32_t detid_t
 Typedef for a detector ID.
typedef std::map< size_t, detid_t > index2detid_map
 Map with key = workspace index, value = detector ID.
typedef std::map< size_t,
specid_t > 		index2spec_map
 Map with key = workspace index, value = spectrum number.
typedef std::vector< double > MantidVec
 typedef for the data storage used in Mantid matrix workspaces
typedef Kernel::cow_ptr
< MantidVec > 		MantidVecPtr
 typedef for the pointer to data storage used in Mantid matrix workspaces
typedef double signal_t
 Typedef for the signal recorded in a MDBox, etc.
typedef std::map< specid_t,
size_t > 		spec2index_map
 Map with key = spectrum number, value = workspace index.
typedef int32_t specid_t
 Typedef for a spectrum ID.

Functions

DLLExport double EMPTY_DBL ()
 Return what we consider to be an empty double.
DLLExport int EMPTY_INT ()
 Returns what we consider an "empty" integer.
DLLExport long EMPTY_LONG ()
 Returns what we consider an "empty" long.
double gsl_costFunction (const gsl_vector *x, void *params)
template<typename CInputIter >
int solveCubic (const CInputIter Coef, std::complex< double > &AnsA, std::complex< double > &AnsB, std::complex< double > &AnsC)
 Solves Cubic equation.
template<typename InputIter >
DLLImport int solveCubic (InputIter, std::complex< double > &, std::complex< double > &, std::complex< double > &)
 Solve a Cubic equation.
template<typename InputIter >
DLLImport int solveQuadratic (InputIter, std::pair< std::complex< double >, std::complex< double > > &)
 Solve a Quadratic equation.
MANTID_KERNEL_DLL std::string welcomeMessage ()
 Returns the welcome message for Mantid.

Detailed Description

XML Parser for parameter types for ImplicitFunctions.

Create markers that will highlight the position of a Peak from a PeaksWorkspace.

Concrete implementation of vtkDataSetFactory.

Stores range values specified by the user.

Unary operation applying visualisation platforms specific conversion from a time to a timestep understood by underlying mantid code, where time is treated as an index in a single dimensional array.

Maps from a timestep to a timestep.

Abstract type promises to supply a minimum and maximum set of threshold range values.

Does not constrain to any range.

Set range selection to cut-out zeros and provide an upper limit equal to the median value in the workspace.

Set range selection to cut-out zeros.

Adapter for action specific to ParaView RebinningCutter filter.

Encapsulates knowledge about switching between rebinning action states.

This file contains the export definitions for various stl containers.

Copyright © 2011 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory.

M.

Defines utility functions and classes for dealing with Python threads.

Based on classes written by Laurent Chapon.

Define some small wrapper and proxy classes for various Mantid C++ classes so that we can override their behaviour in Python.

Define to keep the centroid around as a field on each MDBoxBase.

This structure is the basis and temporary replacement for future subalgorithm, which calculates matrix workspace with various precprocessed detectors parameters.

Set of internal classes used by ConvertToMDEvents algorithm and responsible for Units conversion.

Copyright © 2012 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory.

Copyright © 2010-2011 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory.

This file contains functions to define empty values, i.e EMPTY_INT();.

The class discribes one dimension of multidimensional dataset representing an ortogonal dimension and linear axis.

This file contains typedefs for entities relating to multi-dimensional geometry.

An algorithm to calculate the angular coordinates of the workspace's detectors, as they can be viewed from a sample (par or phx data).

Author:
Owen Arnold, Tessella plc
Date:
01/10/2010

Copyright © 2010 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory

This file is part of Mantid.

Mantid is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

Mantid is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

File change history is stored at: <https://svn.mantidproject.org/mantid/trunk/Code/Mantid> Code Documentation is available at: <http://doxygen.mantidproject.org>

Properties:

Output Properties:

OutputTableWorkspace - the workspace which contains five columns with the following values:

When OutputTable workspace name is empty, the tabled workspace is not defined. To get access to the resulting arrays, the algorithm user has to deploy accessors (getAzimuthal(), getPolar() etc.), defined below, which allows avoiding the transformation of these arrays into strings.

Author:
Alex Buts ISIS; initially extracted from Stuart Campbell's SaveNXSPE algorithm,
Date:
17/05/2012

Copyright © 2009 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory

This file is part of Mantid.

Mantid is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

Mantid is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

File change history is stored at: <https://svn.mantidproject.org/mantid/trunk/Code/Mantid>. Code Documentation is available at: <http://doxygen.mantidproject.org>

Author:
Martyn Gigg, Tessella plc

Copyright © 2011 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory

This file is part of Mantid.

Mantid is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

Mantid is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

File change history is stored at: <https://svn.mantidproject.org/mantid/trunk/Code/Mantid>. Code Documentation is available at: <http://doxygen.mantidproject.org>

Abstract type for a multi dimensional dimension. Gives a read-only layer to the concrete implementation.

Author:
Owen Arnold, RAL ISIS
Date:
12/11/2010

Copyright © 2007-10 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory

This file is part of Mantid.

Mantid is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

Mantid is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

File change history is stored at: <https://svn.mantidproject.org/mantid/trunk/Code/Mantid>. Code Documentation is available at: <http://doxygen.mantidproject.org>

This file is part of Mantid.

Mantid is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

Mantid is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

File change history is stored at: <https://svn.mantidproject.org/mantid/trunk/Code/Mantid>. Code Documentation is available at: <http://doxygen.mantidproject.org>

Date:
11-10-2011

Copyright © 2010 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory

This file is part of Mantid.

Mantid is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

Mantid is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

File change history is stored at: <https://svn.mantidproject.org/mantid/trunk/Code/Mantid> Code Documentation is available at: <http://doxygen.mantidproject.org>

The lightweight class below contain 3D uint vectors, pointing to the positions of the detectors

This vector used to preprocess and catch the partial positions of the detectors in Q-space to avoid repetative calculations, and (possibly) to write these data as part of the physical compression scheme in a very common situation when the physical instrument does not change in all runs, contributed into MD workspace

IT IS USER's RESPONIBLITY TO RECALCULATE THE DETECTOR's PARAMETERS if the derived instrument have changed in a way, which affects the detectors positions and TOF calculations

Date:
22-12-2011

Copyright © 2010 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory

This file is part of Mantid.

Mantid is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

Mantid is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

File change history is stored at: <https://svn.mantidproject.org/mantid/trunk/Code/Mantid> Code Documentation is available at: <http://doxygen.mantidproject.org>

Will help export matrices from UnitCell, Goniometer, OrientedSample, ...

Copyright © 2012 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory

This file is part of Mantid.

Mantid is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

Mantid is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

File change history is stored at: <https://svn.mantidproject.org/mantid/trunk/Code/Mantid> Code Documentation is available at: <http://doxygen.mantidproject.org>

Gigg 2010-12-02: gcc 4.4 warns about an aliasing pointer problem when trying to compile the line .def("getDistance", &Geometry::IComponent::getDistance) It is something to do with the function taking a reference to an IComponent but there doesn't seem to be a problem when it is used so disable the warning but just for this translation unit

This file is part of Mantid.

Mantid is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

Mantid is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

File change history is stored at: <https://svn.mantidproject.org/mantid/trunk/Code/Mantid> Code Documentation is available at: <http://doxygen.mantidproject.org>

This file is part of Mantid.

Mantid is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

Mantid is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

File change history is stored at: <https://svn.mantidproject.org/mantid/trunk/Code/Mantid>

Copyright © 2011 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory

This file is part of Mantid.

Mantid is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

Mantid is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

File change history is stored at: <https://svn.mantidproject.org/mantid/trunk/Code/Mantid> Code Documentation is available at: <http://doxygen.mantidproject.org>

Knows when to escalate a decision to a higher level (i.e, from effectivley do nothing to trigger a full rebin based on the current state and the request made). Simple stragegy pattern, may be one of may used.

Author:
Owen Arnold, Tessella ISIS
Date:
16/04/2011

Copyright © 2007-10 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory

This file is part of Mantid.

Mantid is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

Mantid is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

File change history is stored at: <https://svn.mantidproject.org/mantid/trunk/Code/Mantid>. Code Documentation is available at: <http://doxygen.mantidproject.org>

Handles progress actions raised by underlying Mantid Algorithms.

Author:
Owen Arnold, Tessella plc
Date:
14/03/2011

Copyright © 2010 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory

This file is part of Mantid.

Mantid is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

Mantid is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

File change history is stored at: <https://svn.mantidproject.org/mantid/trunk/Code/Mantid> Code Documentation is available at: <http://doxygen.mantidproject.org>

Author:
Owen Arnold, Tessella plc
Date:
07/07/2011

Copyright © 2010 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory

This file is part of Mantid.

Mantid is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

Mantid is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

File change history is stored at: <https://svn.mantidproject.org/mantid/trunk/Code/Mantid> Code Documentation is available at: <http://doxygen.mantidproject.org>

Author:
Owen Arnold, Tessella plc
Date:
30/06/2011

Copyright © 2010 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory

This file is part of Mantid.

Mantid is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

Mantid is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

File change history is stored at: <https://svn.mantidproject.org/mantid/trunk/Code/Mantid> Code Documentation is available at: <http://doxygen.mantidproject.org>

Provides the static compile time polymorphism required by vtkDataSetFactory type classes.

Author:
Owen Arnold, Tessella plc
Date:
14/03/2011

Copyright © 2010 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory

This file is part of Mantid.

Mantid is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

Mantid is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

File change history is stored at: <https://svn.mantidproject.org/mantid/trunk/Code/Mantid> Code Documentation is available at: <http://doxygen.mantidproject.org>

See MDWorkspace/MDImage.

Author:
Owen Arnold, Tessella plc
Date:
14/03/2011

Copyright © 2010 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory

This file is part of Mantid.

Mantid is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

Mantid is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

File change history is stored at: <https://svn.mantidproject.org/mantid/trunk/Code/Mantid> Code Documentation is available at: <http://doxygen.mantidproject.org>

Creates a vtkUnStructuredGrid. Uses Thresholding technique to create sparse 4D representation of data.

Author:
Owen Arnold, Tessella plc
Date:
24/01/2010

Copyright © 2010 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory

This file is part of Mantid.

Mantid is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

Mantid is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

File change history is stored at: <https://svn.mantidproject.org/mantid/trunk/Code/Mantid> Code Documentation is available at: <http://doxygen.mantidproject.org>

Creates a vtkUnStructuredGrid. Uses Thresholding technique to create sparse 3D representation of data.

Author:
Owen Arnold, Tessella plc
Date:
06/05/2011

Copyright © 2010 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory

This file is part of Mantid.

Mantid is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

Mantid is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

File change history is stored at: <https://svn.mantidproject.org/mantid/trunk/Code/Mantid> Code Documentation is available at: <http://doxygen.mantidproject.org>

Implementation of a vtkDataSetFactory.

Author:
Janik Zikovsky
Date:
06/24/2011

Copyright © 2010 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory

This file is part of Mantid.

Mantid is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

Mantid is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

File change history is stored at: <https://svn.mantidproject.org/mantid/trunk/Code/Mantid> Code Documentation is available at: <http://doxygen.mantidproject.org>

Typedef Documentation

typedef float Mantid::coord_t

Typedef for the data type to use for coordinate axes in MD objects such as MDBox, MDEventWorkspace, etc.

This could be a float or a double, depending on requirements. We can change this in order to compare performance/memory/accuracy requirements.

Definition at line 43 of file MDTypes.h.

typedef std::map<detid_t, Geometry::IDetector_const_sptr> Mantid::detid2det_map

Typedef of a map from detector ID to detector shared pointer.

Definition at line 21 of file Instrument.h.

typedef std::map<detid_t, size_t> Mantid::detid2index_map

Map with key = detector ID, value = workspace index.

Definition at line 23 of file SpectraDetectorTypes.h.

typedef int32_t Mantid::detid_t

Typedef for a detector ID.

Definition at line 15 of file IDTypes.h.

typedef std::map<size_t, detid_t> Mantid::index2detid_map

Map with key = workspace index, value = detector ID.

Definition at line 25 of file SpectraDetectorTypes.h.

typedef std::map< size_t, specid_t > Mantid::index2spec_map

Map with key = workspace index, value = spectrum number.

Definition at line 25 of file SpectraDetectorMap.h.

typedef std::vector<double> Mantid::MantidVec

typedef for the data storage used in Mantid matrix workspaces

Definition at line 172 of file cow_ptr.h.

typedef Kernel::cow_ptr<MantidVec> Mantid::MantidVecPtr

typedef for the pointer to data storage used in Mantid matrix workspaces

Definition at line 175 of file cow_ptr.h.

typedef double Mantid::signal_t

Typedef for the signal recorded in a MDBox, etc.

Note: MDEvents use 'float' internally to save memory

Definition at line 52 of file MDTypes.h.

typedef std::map< specid_t, size_t > Mantid::spec2index_map

Map with key = spectrum number, value = workspace index.

Definition at line 23 of file SpectraDetectorMap.h.

typedef int32_t Mantid::specid_t

Typedef for a spectrum ID.

Definition at line 12 of file IDTypes.h.

Function Documentation

double Mantid::EMPTY_DBL (  ) 

Return what we consider to be an empty double.

Returns what we consider an "empty" double within a property.

Returns:
An flag value

Definition at line 33 of file EmptyValues.cpp.

Referenced by Mantid::Algorithms::ReplaceSpecialValues::checkifPropertyEmpty(), Mantid::Kernel::Detail::checkIsEmpty(), Mantid::Algorithms::ConvertUnits::convertViaTOF(), Mantid::CurveFitting::FitMW::declareDatasetProperties(), Mantid::Algorithms::ReplaceSpecialValues::defineProperties(), Mantid::DataHandling::SaveNXSPE::exec(), Mantid::DataHandling::DetermineChunking::exec(), Mantid::Crystal::FindSXPeaks::exec(), Mantid::Algorithms::SpatialGrouping::exec(), Mantid::Algorithms::MaxMin::exec(), Mantid::Algorithms::Integration::exec(), Mantid::Algorithms::ElasticWindow::exec(), Mantid::Algorithms::DetectorEfficiencyVariation::exec(), Mantid::Algorithms::CorrectKiKf::exec(), Mantid::Algorithms::ChopData::exec(), Mantid::Algorithms::CalculateEfficiency::exec(), Mantid::Algorithms::AlphaCalc::exec(), Mantid::Algorithms::CorrectKiKf::execEvent(), Mantid::Algorithms::ConvertSpectrumAxis::getEfixed(), Mantid::Algorithms::RemovePromptPulse::getFrequency(), Mantid::CurveFitting::FitMW::getStartIterator(), Mantid::Algorithms::RemoveLowResTOF::getTminData(), Mantid::Algorithms::UnwrapSNS::getTofRangeData(), Mantid::WorkflowAlgorithms::SetupHFIRReduction::init(), Mantid::WorkflowAlgorithms::SetupEQSANSReduction::init(), Mantid::WorkflowAlgorithms::SANSSensitivityCorrection::init(), Mantid::WorkflowAlgorithms::SANSBeamFinder::init(), Mantid::WorkflowAlgorithms::RefReduction::init(), Mantid::WorkflowAlgorithms::HFIRLoad::init(), Mantid::WorkflowAlgorithms::EQSANSLoad::init(), Mantid::DataHandling::LoadSpice2D::init(), Mantid::DataHandling::LoadEventNexus::init(), Mantid::DataHandling::DetermineChunking::init(), Mantid::CurveFitting::PlotPeakByLogValue::init(), Mantid::CurveFitting::Linear::init(), Mantid::CurveFitting::Fit1D::init(), Mantid::Crystal::FindSXPeaks::init(), Mantid::Algorithms::UnwrapSNS::init(), Mantid::Algorithms::TOFSANSResolution::init(), Mantid::Algorithms::SumRowColumn::init(), Mantid::Algorithms::RemovePromptPulse::init(), Mantid::Algorithms::RemoveLowResTOF::init(), Mantid::Algorithms::RemoveBins::init(), Mantid::Algorithms::PlotAsymmetryByLogValue::init(), Mantid::Algorithms::NormaliseToUnity::init(), Mantid::Algorithms::NormaliseToMonitor::init(), Mantid::Algorithms::Min::init(), Mantid::Algorithms::MedianDetectorTest::init(), Mantid::Algorithms::MaxMin::init(), Mantid::Algorithms::Max::init(), Mantid::Algorithms::Integration::init(), Mantid::Algorithms::GetEi2::init(), Mantid::Algorithms::FlatBackground::init(), Mantid::Algorithms::FindDetectorsOutsideLimits::init(), Mantid::Algorithms::FindDeadDetectors::init(), Mantid::Algorithms::ElasticWindow::init(), Mantid::Algorithms::DetectorEfficiencyVariation::init(), Mantid::Algorithms::DetectorEfficiencyCor::init(), Mantid::Algorithms::DetectorDiagnostic::init(), Mantid::Algorithms::CropWorkspace::init(), Mantid::Algorithms::CorrectKiKf::init(), Mantid::Algorithms::ConvertUnits::init(), Mantid::Algorithms::ConvertSpectrumAxis::init(), Mantid::Algorithms::ChopData::init(), Mantid::Algorithms::CalculateEfficiency::init(), Mantid::Algorithms::ApplyTransmissionCorrection::init(), Mantid::Algorithms::AlphaCalc::init(), Mantid::API::Algorithm::isEmpty(), Mantid::WorkflowAlgorithms::SANSBeamFinder::loadBeamFinderFile(), Mantid::DataHandling::LoadEventNexus::loadEvents(), Mantid::API::TextAxis::operator()(), Mantid::Algorithms::DetectorEfficiencyCor::retrieveProperties(), and Mantid::DataHandling::LoadEventNexus::setTimeFilters().

int Mantid::EMPTY_INT (  ) 

Returns what we consider an "empty" integer.

Returns what we consider an "empty" integer within a property.

Returns:
An flag value

Definition at line 15 of file EmptyValues.cpp.

Referenced by Mantid::DataHandling::MaskDetectors::appendToIndexListFromMaskWS(), Mantid::DataHandling::MaskDetectors::appendToIndexListFromWS(), Mantid::Kernel::Detail::checkIsEmpty(), Mantid::DataHandling::LoadRawHelper::checkOptionalProperties(), Mantid::DataHandling::LoadRaw2::checkOptionalProperties(), Mantid::DataHandling::LoadRaw::checkOptionalProperties(), Mantid::DataHandling::LoadNexusProcessed::checkOptionalProperties(), Mantid::DataHandling::LoadMuonNexus::checkOptionalProperties(), Mantid::DataHandling::LoadISISNexus2::checkOptionalProperties(), Mantid::DataHandling::LoadISISNexus::checkOptionalProperties(), Mantid::DataHandling::LoadDAE::checkOptionalProperties(), Mantid::DataHandling::SaveAscii::exec(), Mantid::DataHandling::LoadPreNexus::exec(), Mantid::DataHandling::DetermineChunking::exec(), Mantid::Crystal::SetUB::exec(), Mantid::Algorithms::ScaleX::exec(), Mantid::Algorithms::PlotAsymmetryByLogValue::exec(), Mantid::Algorithms::FFT::exec(), Mantid::Algorithms::DetectorEfficiencyVariation::exec(), Mantid::Algorithms::CopySample::exec(), Mantid::Algorithms::ChopData::exec(), Mantid::Algorithms::ChangeBinOffset::exec(), Mantid::DataHandling::SaveNexusProcessed::getSpectrumList(), Mantid::WorkflowAlgorithms::RefRoi::init(), Mantid::WorkflowAlgorithms::RefReduction::init(), Mantid::DataHandling::SaveNexusProcessed::init(), Mantid::DataHandling::SaveNexus::init(), Mantid::DataHandling::SaveAscii::init(), Mantid::DataHandling::MaskDetectors::init(), Mantid::DataHandling::LoadRawBin0::init(), Mantid::DataHandling::LoadRaw3::init(), Mantid::DataHandling::LoadRaw2::init(), Mantid::DataHandling::LoadRaw::init(), Mantid::DataHandling::LoadPreNexus::init(), Mantid::DataHandling::LoadNexusProcessed::init(), Mantid::DataHandling::LoadNexus::init(), Mantid::DataHandling::LoadMuonNexus::init(), Mantid::DataHandling::LoadISISNexus2::init(), Mantid::DataHandling::LoadISISNexus::init(), Mantid::DataHandling::LoadEventPreNexus2::init(), Mantid::DataHandling::LoadEventPreNexus::init(), Mantid::DataHandling::LoadEventNexus::init(), Mantid::DataHandling::LoadDAE::init(), Mantid::DataHandling::LoadAscii::init(), Mantid::Crystal::SetUB::init(), Mantid::Crystal::FindSXPeaks::init(), Mantid::Algorithms::SumSpectra::init(), Mantid::Algorithms::SumRowColumn::init(), Mantid::Algorithms::StripVanadiumPeaks2::init(), Mantid::Algorithms::StripVanadiumPeaks::init(), Mantid::Algorithms::StripPeaks::init(), Mantid::Algorithms::SolidAngle::init(), Mantid::Algorithms::ScaleX::init(), Mantid::Algorithms::RemoveBins::init(), Mantid::Algorithms::PlotAsymmetryByLogValue::init(), Mantid::Algorithms::NormaliseToUnity::init(), Mantid::Algorithms::MultiplyRange::init(), Mantid::Algorithms::MonteCarloAbsorption::init(), Mantid::Algorithms::Min::init(), Mantid::Algorithms::MedianDetectorTest::init(), Mantid::Algorithms::MaxMin::init(), Mantid::Algorithms::Max::init(), Mantid::Algorithms::Integration::init(), Mantid::Algorithms::HRPDSlabCanAbsorption::init(), Mantid::Algorithms::FindPeaks::init(), Mantid::Algorithms::FindDetectorsOutsideLimits::init(), Mantid::Algorithms::FFT::init(), Mantid::Algorithms::DetectorEfficiencyVariation::init(), Mantid::Algorithms::DetectorDiagnostic::init(), Mantid::Algorithms::CropWorkspace::init(), Mantid::Algorithms::CopySample::init(), Mantid::Algorithms::ChopData::init(), Mantid::Algorithms::ChangeBinOffset::init(), Mantid::Algorithms::CalculateTransmission::init(), Mantid::Algorithms::AbsorptionCorrection::init(), MantidQt::CustomInterfaces::SANSDiagnostics::IntegralClicked(), Mantid::API::Algorithm::isEmpty(), MantidQt::CustomInterfaces::SANSDiagnostics::isValidSpectra(), Mantid::DataHandling::LoadEventNexus::loadEvents(), Mantid::DataHandling::LoadAscii::processHeader(), Mantid::Algorithms::MedianDetectorTest::retrieveProperties(), Mantid::Algorithms::DetectorEfficiencyVariation::retrieveProperties(), Mantid::DataHandling::LoadNexus::runLoadIsisNexus(), Mantid::DataHandling::LoadNexus::runLoadMuonNexus(), Mantid::DataHandling::LoadNexus::runLoadSNSNexus(), and Mantid::DataHandling::SaveNexus::runSaveNexusProcessed().

long Mantid::EMPTY_LONG (  ) 

Returns what we consider an "empty" long.

Returns what we consider an "empty" long within a property.

Returns:
An flag value

Definition at line 24 of file EmptyValues.cpp.

Referenced by Mantid::Kernel::Detail::checkIsEmpty().

double Mantid::gsl_costFunction ( const gsl_vector *  x,
void *  params 
)
template<typename CInputIter >
int Mantid::solveCubic ( const CInputIter  Coef,
std::complex< double > &  AnsA,
std::complex< double > &  AnsB,
std::complex< double > &  AnsC 
) [inline]

Solves Cubic equation.

Parameters:
Coef :: iterator over all the coefients in the order

\[ Ax^3+Bx^2+Cx+D \]

.

AnsA,AnsB,AnsC :: complex roots of the equation
Returns:
number of unique solutions

Definition at line 63 of file mathSupport.cpp.

References M_PI, and solveQuadratic().

template<typename InputIter >
DLLImport int Mantid::solveCubic ( InputIter  ,
std::complex< double > &  ,
std::complex< double > &  ,
std::complex< double > &   
) [inline]

Solve a Cubic equation.

template<typename InputIter >
int Mantid::solveQuadratic ( const InputIter  Coef,
std::pair< std::complex< double >, std::complex< double > > &  OutAns 
) [inline]

Solve a Quadratic equation.

Solves Complex Quadratic.

Parameters:
Coef :: iterator over all the coefients in the order

\[ Ax^2+Bx+C \]

.

OutAns :: complex roots of the equation
Returns:
number of unique solutions

Definition at line 16 of file mathSupport.cpp.

Referenced by Mantid::Geometry::Line::intersect(), and solveCubic().

std::string Mantid::welcomeMessage (  ) 

Returns the welcome message for Mantid.

Get the welcome message for Mantid.

Returns:
A string containing the welcome message for Mantid.

Definition at line 51 of file ConfigService.cpp.

Referenced by MantidUI::init().

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines
Generated on 19 May 2012 for Mantid by  doxygen 1.6.1