diff --git a/Framework/PythonInterface/mantid/api/src/Exports/Algorithm.cpp b/Framework/PythonInterface/mantid/api/src/Exports/Algorithm.cpp index d3798d6efde3b25edf3432b64cb091b75ea087cd..41ef7653cab198b0bf25e53be4fe86f9254f47b0 100644 --- a/Framework/PythonInterface/mantid/api/src/Exports/Algorithm.cpp +++ b/Framework/PythonInterface/mantid/api/src/Exports/Algorithm.cpp @@ -83,14 +83,14 @@ void export_leaf_classes() { "Creates and intializes a named child algorithm. Output workspaces " "are given a dummy name.") .def("declareProperty", - (declarePropertyType1) & PythonAlgorithm::declarePyAlgProperty, + (declarePropertyType1)&PythonAlgorithm::declarePyAlgProperty, declarePropertyType1_Overload( (arg("self"), arg("prop"), arg("doc") = ""))) .def("enableHistoryRecordingForChild", &Algorithm::enableHistoryRecordingForChild, (args("on")), "Turns history recording on or off for an algorithm.") .def("declareProperty", - (declarePropertyType2) & PythonAlgorithm::declarePyAlgProperty, + (declarePropertyType2)&PythonAlgorithm::declarePyAlgProperty, declarePropertyType2_Overload( (arg("self"), arg("name"), arg("defaultValue"), arg("validator") = object(), arg("doc") = "", @@ -99,7 +99,7 @@ void export_leaf_classes() { "the type of the defaultValue and mapped to an appropriate C++ " "type")) .def("declareProperty", - (declarePropertyType3) & PythonAlgorithm::declarePyAlgProperty, + (declarePropertyType3)&PythonAlgorithm::declarePyAlgProperty, declarePropertyType3_Overload( (arg("self"), arg("name"), arg("defaultValue"), arg("doc") = "", arg("direction") = Direction::Input), @@ -107,7 +107,7 @@ void export_leaf_classes() { "type " "of the defaultValue and mapped to an appropriate C++ type")) .def("declareProperty", - (declarePropertyType4) & PythonAlgorithm::declarePyAlgProperty, + (declarePropertyType4)&PythonAlgorithm::declarePyAlgProperty, (arg("self"), arg("name"), arg("defaultValue"), arg("direction") = Direction::Input), "Declares a named property where the type is taken from the type " diff --git a/Framework/PythonInterface/mantid/api/src/Exports/Axis.cpp b/Framework/PythonInterface/mantid/api/src/Exports/Axis.cpp index 4ddd749fd65a76974bb29d85df243d9b78ebb256..2c1705e25f19b0fd65b9c4876f13b0b83d6d1128 100644 --- a/Framework/PythonInterface/mantid/api/src/Exports/Axis.cpp +++ b/Framework/PythonInterface/mantid/api/src/Exports/Axis.cpp @@ -73,53 +73,41 @@ void export_Axis() { // Class class_<Axis, boost::noncopyable>("MantidAxis", no_init) - .def("length", &Axis::length, - arg("self"), + .def("length", &Axis::length, arg("self"), "Returns the length of the axis") .def("title", (const std::string &(Axis::*)() const) & Axis::title, - arg("self"), - return_value_policy<copy_const_reference>(), "Get the axis title") - .def("isSpectra", &Axis::isSpectra, - arg("self"), + arg("self"), return_value_policy<copy_const_reference>(), + "Get the axis title") + .def("isSpectra", &Axis::isSpectra, arg("self"), "Returns true if this is a SpectraAxis") - .def("isNumeric", &Axis::isNumeric, - arg("self"), + .def("isNumeric", &Axis::isNumeric, arg("self"), "Returns true if this is a NumericAxis") - .def("isText", &Axis::isText, - arg("self"), + .def("isText", &Axis::isText, arg("self"), "Returns true if this is a TextAxis") - .def("label", &Axis::label, - (arg("self"), arg("index")), + .def("label", &Axis::label, (arg("self"), arg("index")), "Return the axis label") .def("getUnit", (const Unit_sptr &(Axis::*)() const) & Axis::unit, - arg("self"), - return_value_policy<copy_const_reference>(), + arg("self"), return_value_policy<copy_const_reference>(), "Returns the unit object for the axis") .def("getValue", &Axis::getValue, Axis_getValue(args("index", "vertical_index"), "Returns the value at the given point on the Axis. " "The vertical axis index [default=0]")) - .def("extractValues", &extractAxisValues, - arg("self"), + .def("extractValues", &extractAxisValues, arg("self"), "Return a numpy array of the axis values") - .def("setUnit", &Axis::setUnit, - (arg("self"), arg("unit_name")), + .def("setUnit", &Axis::setUnit, (arg("self"), arg("unit_name")), return_value_policy<copy_const_reference>(), "Set the unit for this axis by name.") .def("setValue", &Axis::setValue, (arg("self"), arg("index"), arg("value")), "Set a value at the given index") - .def("getMin", &Axis::getMin, - arg("self"), + .def("getMin", &Axis::getMin, arg("self"), "Get min value specified on the axis") - .def("getMax", &Axis::getMax, - arg("self"), + .def("getMax", &Axis::getMax, arg("self"), "Get max value specified on the axis") //------------------------------------ Special methods //------------------------------------ - .def("__len__", - &Axis::length, - arg("self")); + .def("__len__", &Axis::length, arg("self")); } // -------------------------------------------------------------------------------------------- @@ -182,11 +170,9 @@ void export_TextAxis() { .def("setLabel", &TextAxis::setLabel, (arg("self"), arg("index"), arg("label")), "Set the label at the given entry") - .def("label", &TextAxis::label, - (arg("self"), arg("index")), + .def("label", &TextAxis::label, (arg("self"), arg("index")), "Return the label at the given position") - .def("create", &createTextAxis, - arg("length"), + .def("create", &createTextAxis, arg("length"), return_internal_reference<>(), "Creates a new TextAxis of a specified length") .staticmethod("create"); diff --git a/Framework/PythonInterface/mantid/api/src/Exports/IAlgorithm.cpp b/Framework/PythonInterface/mantid/api/src/Exports/IAlgorithm.cpp index be1396fd1ba8d1fcf903ac5cdadb6dd15012d628..f70cc83498347088a630dcd653e761f406287166 100644 --- a/Framework/PythonInterface/mantid/api/src/Exports/IAlgorithm.cpp +++ b/Framework/PythonInterface/mantid/api/src/Exports/IAlgorithm.cpp @@ -302,54 +302,41 @@ void export_ialgorithm() { class_<IAlgorithm, bases<IPropertyManager>, boost::noncopyable>( "IAlgorithm", "Interface for all algorithms", no_init) - .def("name", &IAlgorithm::name, - arg("self"), + .def("name", &IAlgorithm::name, arg("self"), "Returns the name of the algorithm") - .def("alias", &IAlgorithm::alias, - arg("self"), + .def("alias", &IAlgorithm::alias, arg("self"), "Return the aliases for the algorithm") - .def("version", &IAlgorithm::version, - arg("self"), + .def("version", &IAlgorithm::version, arg("self"), "Returns the version number of the algorithm") - .def("cancel", &IAlgorithm::cancel, - arg("self"), + .def("cancel", &IAlgorithm::cancel, arg("self"), "Request that the algorithm stop running") - .def("category", &IAlgorithm::category, - arg("self"), + .def("category", &IAlgorithm::category, arg("self"), "Returns the category containing the algorithm") - .def("categories", &IAlgorithm::categories, - arg("self"), + .def("categories", &IAlgorithm::categories, arg("self"), "Returns the list of categories this algorithm belongs to") - .def("summary", &IAlgorithm::summary, - arg("self"), + .def("summary", &IAlgorithm::summary, arg("self"), "Returns a summary message describing the algorithm") - .def("workspaceMethodName", &IAlgorithm::workspaceMethodName, - arg("self"), + .def("workspaceMethodName", &IAlgorithm::workspaceMethodName, arg("self"), "Returns a name that will be used when attached as a workspace " "method. Empty string indicates do not attach") - .def("workspaceMethodOn", &IAlgorithm::workspaceMethodOn, - arg("self"), + .def("workspaceMethodOn", &IAlgorithm::workspaceMethodOn, arg("self"), return_value_policy<VectorToNumpy>(), // creates a list for strings "Returns a set of class names that will have the method attached. " "Empty list indicates all types") .def("workspaceMethodInputProperty", - &IAlgorithm::workspaceMethodInputProperty, - arg("self"), + &IAlgorithm::workspaceMethodInputProperty, arg("self"), "Returns the name of the input workspace property used by the " "calling object") - .def("getAlgorithmID", &getAlgorithmID, - arg("self"), + .def("getAlgorithmID", &getAlgorithmID, arg("self"), "Returns a unique identifier for this algorithm object") - .def("docString", &createDocString, - arg("self"), + .def("docString", &createDocString, arg("self"), "Returns a doc string for the algorithm") .def("mandatoryProperties", &getInputPropertiesWithMandatoryFirst, arg("self"), "Returns a list of input and in/out property names that is ordered " "such that the mandatory properties are first followed by the " "optional ones.") - .def("orderedProperties", &getAlgorithmPropertiesOrdered, - arg("self"), + .def("orderedProperties", &getAlgorithmPropertiesOrdered, arg("self"), "Return a list of input, in/out and output properties " "such that the mandatory properties are first followed by the " "optional ones.") diff --git a/Framework/PythonInterface/mantid/api/src/Exports/IFunction.cpp b/Framework/PythonInterface/mantid/api/src/Exports/IFunction.cpp index 020b9cf7aad6844917c0f9a77fdb7827d30305ab..9e7b21eb69d850ca3c28089415cc14ed05f297f0 100644 --- a/Framework/PythonInterface/mantid/api/src/Exports/IFunction.cpp +++ b/Framework/PythonInterface/mantid/api/src/Exports/IFunction.cpp @@ -51,42 +51,33 @@ void export_IFunction() { class_<IFunction, IFunctionAdapter, boost::noncopyable>( "IFunction", "Base class for all functions", no_init) - .def("name", &IFunction::name, - arg("self"), + .def("name", &IFunction::name, arg("self"), "Return the name of the function") - .def("category", &IFunctionAdapter::category, - arg("self"), + .def("category", &IFunctionAdapter::category, arg("self"), "Return a semi-colon(;) separated string for the categories this " "class should belong to. For sub-categories use a \\ separator") - .def("initialize", &IFunction::initialize, - arg("self"), + .def("initialize", &IFunction::initialize, arg("self"), "Declares any parameters and attributes on the function") - .def("getCategories", &getCategories, - arg("self"), + .def("getCategories", &getCategories, arg("self"), "Returns a list of the categories for an algorithm") - .def("nAttributes", &IFunction::nAttributes, - arg("self"), + .def("nAttributes", &IFunction::nAttributes, arg("self"), "Return the number of attributes (non-fitting arguments)") - .def("attributeNames", &IFunction::getAttributeNames, - arg("self"), + .def("attributeNames", &IFunction::getAttributeNames, arg("self"), "The names of all the attributes") - .def("nParams", &IFunction::nParams, - arg("self"), + .def("nParams", &IFunction::nParams, arg("self"), "Return the number of parameters") - .def("parameterName", &IFunction::parameterName, - (arg("self"), arg("i")), + .def("parameterName", &IFunction::parameterName, (arg("self"), arg("i")), "Return the name of the ith parameter") .def("paramDescription", &IFunction::parameterDescription, - (arg("self"), arg("i")), - "Return a description of the ith parameter") + (arg("self"), arg("i")), "Return a description of the ith parameter") .def("isExplicitlySet", &IFunction::isExplicitlySet, (arg("self"), arg("i")), @@ -94,14 +85,12 @@ void export_IFunction() { .def("getParameterValue", (double (IFunction::*)(size_t) const) & IFunction::getParameter, - (arg("self"), arg("i")), - "Get the value of the ith parameter") + (arg("self"), arg("i")), "Get the value of the ith parameter") .def("getParameterValue", (double (IFunction::*)(const std::string &) const) & IFunction::getParameter, - (arg("self"), arg("name")), - "Get the value of the named parameter") + (arg("self"), arg("name")), "Get the value of the named parameter") .def("setParameter", (setParameterType1)&IFunction::setParameter, setParameterType1_Overloads("Sets the value of the ith parameter")) diff --git a/Framework/PythonInterface/mantid/api/src/Exports/IMDEventWorkspace.cpp b/Framework/PythonInterface/mantid/api/src/Exports/IMDEventWorkspace.cpp index a9f042ec247b7848e51f67b98d60b9d0705c57c6..4bd404f62e4b60fe2af7038ce00b91a43326241e 100644 --- a/Framework/PythonInterface/mantid/api/src/Exports/IMDEventWorkspace.cpp +++ b/Framework/PythonInterface/mantid/api/src/Exports/IMDEventWorkspace.cpp @@ -12,18 +12,15 @@ void export_IMDEventWorkspace() { // IMDEventWorkspace class class_<IMDEventWorkspace, bases<IMDWorkspace, MultipleExperimentInfos>, boost::noncopyable>("IMDEventWorkspace", no_init) - .def("getNPoints", &IMDEventWorkspace::getNPoints, - arg("self"), + .def("getNPoints", &IMDEventWorkspace::getNPoints, arg("self"), "Returns the total number of points (events) in this workspace") - .def("getNumDims", &IMDEventWorkspace::getNumDims, - arg("self"), + .def("getNumDims", &IMDEventWorkspace::getNumDims, arg("self"), "Returns the number of dimensions in this workspace") .def("getBoxController", (BoxController_sptr (IMDEventWorkspace::*)()) & IMDEventWorkspace::getBoxController, - arg("self"), - "Returns the BoxController used in this workspace"); + arg("self"), "Returns the BoxController used in this workspace"); RegisterWorkspacePtrToPython<IMDEventWorkspace>(); } diff --git a/Framework/PythonInterface/mantid/api/src/Exports/IMDHistoWorkspace.cpp b/Framework/PythonInterface/mantid/api/src/Exports/IMDHistoWorkspace.cpp index 3ae6965e77ef8dc2b8e74d57e4d502b217ecc496..5ed3e256452c4064c387b2dc7a9b565bab4cc377 100644 --- a/Framework/PythonInterface/mantid/api/src/Exports/IMDHistoWorkspace.cpp +++ b/Framework/PythonInterface/mantid/api/src/Exports/IMDHistoWorkspace.cpp @@ -167,8 +167,7 @@ void export_IMDHistoWorkspace() { // IMDHistoWorkspace class class_<IMDHistoWorkspace, bases<IMDWorkspace, MultipleExperimentInfos>, boost::noncopyable>("IMDHistoWorkspace", no_init) - .def("getSignalArray", &getSignalArrayAsNumpyArray, - arg("self"), + .def("getSignalArray", &getSignalArrayAsNumpyArray, arg("self"), "Returns a read-only numpy array containing the signal values") .def("getErrorSquaredArray", &getErrorSquaredArrayAsNumpyArray, @@ -176,8 +175,7 @@ void export_IMDHistoWorkspace() { "Returns a read-only numpy array containing the square of the error " "values") - .def("getNumEventsArray", &getNumEventsArrayAsNumpyArray, - arg("self"), + .def("getNumEventsArray", &getNumEventsArrayAsNumpyArray, arg("self"), "Returns a read-only numpy array containing the number of MD events " "in each bin") @@ -199,23 +197,21 @@ void export_IMDHistoWorkspace() { (arg("self"), arg("index"), arg("value")), "Sets the squared-error at the specified index.") - .def("setSignalArray", &setSignalArray, - arg("self"), + .def("setSignalArray", &setSignalArray, arg("self"), "Sets the signal from a numpy array. The sizes must match the " "current workspace sizes. A ValueError is thrown if not") - .def("setErrorSquaredArray", &setErrorSquaredArray, - arg("self"), + .def("setErrorSquaredArray", &setErrorSquaredArray, arg("self"), "Sets the square of the errors from a numpy array. The sizes must " "match the current workspace sizes. A ValueError is thrown if not") .def("setTo", &IMDHistoWorkspace::setTo, - (arg("self"), arg("signal"), arg("error_squared"), arg("num_events")), + (arg("self"), arg("signal"), arg("error_squared"), + arg("num_events")), "Sets all signals/errors in the workspace to the given values") .def("getInverseVolume", &IMDHistoWorkspace::getInverseVolume, - arg("self"), - return_value_policy<return_by_value>(), + arg("self"), return_value_policy<return_by_value>(), "Return the inverse of volume of EACH cell in the workspace.") .def("getLinearIndex", @@ -236,7 +232,8 @@ void export_IMDHistoWorkspace() { (size_t (IMDHistoWorkspace::*)(size_t, size_t, size_t, size_t) const) & IMDHistoWorkspace::getLinearIndex, - (arg("self"), arg("index1"), arg("index2"), arg("index3"), arg("index4")), + (arg("self"), arg("index1"), arg("index2"), arg("index3"), + arg("index4")), return_value_policy<return_by_value>(), "Get the 1D linear index from the 4D array") diff --git a/Framework/PythonInterface/mantid/api/src/Exports/IPeak.cpp b/Framework/PythonInterface/mantid/api/src/Exports/IPeak.cpp index 41bd81c045379c771be0f06261d4d746a7b7d1ce..3dcc380b56de3f45d08f8d1d833cccbcbc67eabe 100644 --- a/Framework/PythonInterface/mantid/api/src/Exports/IPeak.cpp +++ b/Framework/PythonInterface/mantid/api/src/Exports/IPeak.cpp @@ -36,78 +36,58 @@ void export_IPeak() { register_ptr_to_python<IPeak *>(); class_<IPeak, boost::noncopyable>("IPeak", no_init) - .def("getDetectorID", &IPeak::getDetectorID, - arg("self"), + .def("getDetectorID", &IPeak::getDetectorID, arg("self"), "Get the ID of the detector at the center of the peak") - .def("setDetectorID", &IPeak::setDetectorID, - (arg("self"), arg("det_id")), + .def("setDetectorID", &IPeak::setDetectorID, (arg("self"), arg("det_id")), "Set the detector ID and look up and cache values related to it.") - .def("getRunNumber", &IPeak::getRunNumber, - arg("self"), + .def("getRunNumber", &IPeak::getRunNumber, arg("self"), "Return the run number this peak was measured at") .def("setRunNumber", &IPeak::setRunNumber, (arg("self"), arg("run_number")), "Set the run number that measured this peak") - .def("getMonitorCount", &IPeak::getMonitorCount, - arg("self"), + .def("getMonitorCount", &IPeak::getMonitorCount, arg("self"), "Get the monitor count set for this peak") .def("setMonitorCount", &IPeak::setMonitorCount, (arg("self"), arg("monitor_count")), "Set the monitor count for this peak") - .def("getH", &IPeak::getH, - arg("self"), - "Get the H index of the peak") - .def("getK", &IPeak::getK, - arg("self"), - "Get the K index of the peak") - .def("getL", &IPeak::getL, - arg("self"), - "Get the L index of the peak") - .def("getHKL", &IPeak::getHKL, - arg("self"), - "Get HKL as a V3D object") + .def("getH", &IPeak::getH, arg("self"), "Get the H index of the peak") + .def("getK", &IPeak::getK, arg("self"), "Get the K index of the peak") + .def("getL", &IPeak::getL, arg("self"), "Get the L index of the peak") + .def("getHKL", &IPeak::getHKL, arg("self"), "Get HKL as a V3D object") .def("setHKL", (void (IPeak::*)(double, double, double)) & IPeak::setHKL, (arg("self"), arg("h"), arg("k"), arg("l")), "Set the HKL values of this peak") - .def("setH", &IPeak::setH, - (arg("self"), arg("h")), + .def("setH", &IPeak::setH, (arg("self"), arg("h")), "Get the H index of the peak") - .def("setK", &IPeak::setK, - (arg("self"), arg("k")), + .def("setK", &IPeak::setK, (arg("self"), arg("k")), "Get the K index of the peak") - .def("setL", &IPeak::setL, - (arg("self"), arg("l")), + .def("setL", &IPeak::setL, (arg("self"), arg("l")), "Get the L index of the peak") - .def("getQLabFrame", &IPeak::getQLabFrame, - arg("self"), + .def("getQLabFrame", &IPeak::getQLabFrame, arg("self"), "Return the Q change (of the lattice, k_i - k_f) for this peak.\n" "The Q is in the Lab frame: the goniometer rotation was NOT taken " "out.\n" "Note: There is no 2*pi factor used, so \\|Q| = 1/wavelength.") - .def("findDetector", &IPeak::findDetector, - arg("self"), + .def("findDetector", &IPeak::findDetector, arg("self"), "Using the instrument set in the peak, perform ray tracing to find " "the exact detector.") - .def("getQSampleFrame", &IPeak::getQSampleFrame, - arg("self"), + .def("getQSampleFrame", &IPeak::getQSampleFrame, arg("self"), "Return the Q change (of the lattice, k_i - k_f) for this peak." "The Q is in the Sample frame: the goniometer rotation WAS taken " "out. ") - .def("setQLabFrame", setQLabFrame1, - (arg("self"), arg("qlab_frame")), + .def("setQLabFrame", setQLabFrame1, (arg("self"), arg("qlab_frame")), "Set the peak using the peak's " - "position in reciprocal space, in " - "the lab frame.") + "position in reciprocal space, in " + "the lab frame.") .def("setQLabFrame", setQLabFrame2, (arg("self"), arg("qlab_frame"), arg("distance")), "Set the peak using the peak's position in reciprocal space, in the " "lab frame. Detector distance explicitly supplied.") // two argument // overload .def("setQSampleFrame", setQSampleFrame1, - (arg("self"), arg("qsample_frame")), - "Set the peak using the peak's " - "position in reciprocal space, " - "in the sample frame.") + (arg("self"), arg("qsample_frame")), "Set the peak using the peak's " + "position in reciprocal space, " + "in the sample frame.") .def("setQSampleFrame", setQSampleFrame2, (arg("self"), arg("qsample_frame"), arg("distance")), "Set the peak using the peak's position in reciprocal space, in the " @@ -116,69 +96,51 @@ void export_IPeak() { (arg("self"), arg("wave_length")), "Set the incident wavelength of the neutron. Calculates the energy " "from this assuming elastic scattering.") - .def("getWavelength", &IPeak::getWavelength, - arg("self"), + .def("getWavelength", &IPeak::getWavelength, arg("self"), "Return the incident wavelength") - .def("getScattering", &IPeak::getScattering, - arg("self"), + .def("getScattering", &IPeak::getScattering, arg("self"), "Calculate the scattering angle of the peak") - .def("getDSpacing", &IPeak::getDSpacing, - arg("self"), + .def("getDSpacing", &IPeak::getDSpacing, arg("self"), "Calculate the d-spacing of the peak, in 1/Angstroms") - .def("getTOF", &IPeak::getTOF, - arg("self"), + .def("getTOF", &IPeak::getTOF, arg("self"), "Calculate the time of flight (in " "microseconds) of the neutrons for this " "peak") - .def("getInitialEnergy", &IPeak::getInitialEnergy, - arg("self"), + .def("getInitialEnergy", &IPeak::getInitialEnergy, arg("self"), "Get the initial (incident) neutron energy") - .def("getFinalEnergy", &IPeak::getFinalEnergy, - arg("self"), + .def("getFinalEnergy", &IPeak::getFinalEnergy, arg("self"), "Get the final neutron energy") .def("setInitialEnergy", &IPeak::setInitialEnergy, (arg("self"), arg("initial_energy")), "Set the initial (incident) neutron energy") .def("setFinalEnergy", &IPeak::setFinalEnergy, - (arg("self"), arg("final_energy")), - "Set the final neutron energy") - .def("getIntensity", &IPeak::getIntensity, - arg("self"), + (arg("self"), arg("final_energy")), "Set the final neutron energy") + .def("getIntensity", &IPeak::getIntensity, arg("self"), "Return the integrated peak intensity") - .def("getSigmaIntensity", &IPeak::getSigmaIntensity, - arg("self"), + .def("getSigmaIntensity", &IPeak::getSigmaIntensity, arg("self"), "Return the error on the integrated peak intensity") .def("setIntensity", &IPeak::setIntensity, - (arg("self"), arg("intensity")), - "Set the integrated peak intensity") + (arg("self"), arg("intensity")), "Set the integrated peak intensity") .def("setSigmaIntensity", &IPeak::setSigmaIntensity, (arg("self"), arg("sigma_intensity")), "Set the error on the integrated peak intensity") .def("getBinCount", &IPeak::getBinCount, "Return the # of counts in the bin at its peak") - .def("setBinCount", &IPeak::setBinCount, - (arg("self"), arg("bin_count")), + .def("setBinCount", &IPeak::setBinCount, (arg("self"), arg("bin_count")), "Set the # of counts in the bin at its peak") - .def("getRow", &IPeak::getRow, - arg("self"), + .def("getRow", &IPeak::getRow, arg("self"), "For RectangularDetectors only, returns " "the row (y) of the pixel of the " "detector.") - .def("getCol", &IPeak::getCol, - arg("self"), + .def("getCol", &IPeak::getCol, arg("self"), "For RectangularDetectors only, returns " "the column (x) of the pixel of the " "detector.") - .def("getDetPos", &IPeak::getDetPos, - arg("self"), + .def("getDetPos", &IPeak::getDetPos, arg("self"), "Return the detector position vector") - .def("getL1", &IPeak::getL1, - arg("self"), + .def("getL1", &IPeak::getL1, arg("self"), "Return the L1 flight path length (source to sample), in meters. ") - .def("getL2", &IPeak::getL2, - arg("self"), + .def("getL2", &IPeak::getL2, arg("self"), "Return the L2 flight path length (sample to detector), in meters.") - .def("getPeakShape", getPeakShape, - arg("self"), - "Get the peak shape"); + .def("getPeakShape", getPeakShape, arg("self"), "Get the peak shape"); } diff --git a/Framework/PythonInterface/mantid/api/src/Exports/IPeakFunction.cpp b/Framework/PythonInterface/mantid/api/src/Exports/IPeakFunction.cpp index 0c0c19486ea22b10b222ed4224f5c1ad5669221a..3ac4f6332732a278c3b3ffaa9371cdb41d21edf9 100644 --- a/Framework/PythonInterface/mantid/api/src/Exports/IPeakFunction.cpp +++ b/Framework/PythonInterface/mantid/api/src/Exports/IPeakFunction.cpp @@ -17,8 +17,7 @@ void export_IPeakFunction() { (arg("self"), arg("vec_x")), "Calculate the values of the function for the given x values. The " "output should be stored in the out array") - .def("intensity", &IPeakFunction::intensity, - arg("self"), + .def("intensity", &IPeakFunction::intensity, arg("self"), "Returns the integral intensity of the peak function.") .def("setIntensity", &IPeakFunction::setIntensity, (arg("self"), arg("new_intensity")), diff --git a/Framework/PythonInterface/mantid/api/src/Exports/IPeaksWorkspace.cpp b/Framework/PythonInterface/mantid/api/src/Exports/IPeaksWorkspace.cpp index 2ccf1151a06b14a731fb72fcdd91ad26ed97e496..392d246c8fc1f0b33b63ddbeb98e747aabadd1de 100644 --- a/Framework/PythonInterface/mantid/api/src/Exports/IPeaksWorkspace.cpp +++ b/Framework/PythonInterface/mantid/api/src/Exports/IPeaksWorkspace.cpp @@ -40,20 +40,16 @@ void export_IPeaksWorkspace() { // IPeaksWorkspace class class_<IPeaksWorkspace, bases<ITableWorkspace, ExperimentInfo>, boost::noncopyable>("IPeaksWorkspace", no_init) - .def("getNumberPeaks", &IPeaksWorkspace::getNumberPeaks, - arg("self"), + .def("getNumberPeaks", &IPeaksWorkspace::getNumberPeaks, arg("self"), "Returns the number of peaks within the workspace") - .def("addPeak", &IPeaksWorkspace::addPeak, - (arg("self"), arg("peak")), + .def("addPeak", &IPeaksWorkspace::addPeak, (arg("self"), arg("peak")), "Add a peak to the workspace") .def("removePeak", &IPeaksWorkspace::removePeak, - (arg("self"), arg("peak_num")), - "Remove a peak from the workspace") + (arg("self"), arg("peak_num")), "Remove a peak from the workspace") .def("getPeak", &IPeaksWorkspace::getPeakPtr, - (arg("self"), arg("peak_num")), - return_internal_reference<>(), "Returns a peak at the given index") - .def("createPeak", createPeakQLab, - (arg("self"), arg("data")), + (arg("self"), arg("peak_num")), return_internal_reference<>(), + "Returns a peak at the given index") + .def("createPeak", createPeakQLab, (arg("self"), arg("data")), return_value_policy<manage_new_object>(), "Create a Peak and return it from its coordinates in the QLab frame") .def("createPeak", createPeakQLabWithDistance, @@ -61,15 +57,12 @@ void export_IPeaksWorkspace() { return_value_policy<manage_new_object>(), "Create a Peak and return it from its coordinates in the QLab " "frame, detector-sample distance explicitly provided") - .def("createPeakHKL", createPeakHKL, - (arg("self"), arg("data")), + .def("createPeakHKL", createPeakHKL, (arg("self"), arg("data")), return_value_policy<manage_new_object>(), "Create a Peak and return it from its coordinates in the HKL frame") .def("hasIntegratedPeaks", &IPeaksWorkspace::hasIntegratedPeaks, - arg("self"), - "Determine if the peaks have been integrated") - .def("getRun", &IPeaksWorkspace::mutableRun, - arg("self"), + arg("self"), "Determine if the peaks have been integrated") + .def("getRun", &IPeaksWorkspace::mutableRun, arg("self"), return_internal_reference<>(), "Return the Run object for this workspace") .def("peakInfoNumber", &IPeaksWorkspace::peakInfoNumber, diff --git a/Framework/PythonInterface/mantid/api/src/Exports/ISpectrum.cpp b/Framework/PythonInterface/mantid/api/src/Exports/ISpectrum.cpp index ea0cbceda97aed3cf65837e0aa5b563cfd3461b1..3afbf36902caa3b24d84fadceb531e4cddd67ca3 100644 --- a/Framework/PythonInterface/mantid/api/src/Exports/ISpectrum.cpp +++ b/Framework/PythonInterface/mantid/api/src/Exports/ISpectrum.cpp @@ -14,28 +14,22 @@ void export_ISpectrum() { .def("hasDetectorID", &ISpectrum::hasDetectorID, (arg("self"), arg("det_id")), "Returns True if the spectrum contain the given spectrum number") - .def("getSpectrumNo", &ISpectrum::getSpectrumNo, - arg("self"), + .def("getSpectrumNo", &ISpectrum::getSpectrumNo, arg("self"), "Returns the spectrum number of this spectrum") .def("getDetectorIDs", (const std::set<detid_t> &(ISpectrum::*)() const) & ISpectrum::getDetectorIDs, - arg("self"), - return_value_policy<copy_const_reference>(), + arg("self"), return_value_policy<copy_const_reference>(), "Returns a list of detector IDs for this spectrum") .def("addDetectorID", &ISpectrum::addDetectorID, - (arg("self"), arg("det_id")), - "Add a detector ID to this spectrum") + (arg("self"), arg("det_id")), "Add a detector ID to this spectrum") .def("setDetectorID", &ISpectrum::setDetectorID, - (arg("self"), arg("det_id")), - "Set the given ID has the only") - .def("clearDetectorIDs", &ISpectrum::clearDetectorIDs, - arg("self"), + (arg("self"), arg("det_id")), "Set the given ID has the only") + .def("clearDetectorIDs", &ISpectrum::clearDetectorIDs, arg("self"), "Clear the set of detector IDs") .def("setSpectrumNo", &ISpectrum::setSpectrumNo, (arg("self"), arg("num")), "Set the spectrum number for this spectrum") - .def("hasDx", &ISpectrum::hasDx, - arg("self"), + .def("hasDx", &ISpectrum::hasDx, arg("self"), "Returns True if the spectrum uses the " "DX (X Error) array, else False."); } diff --git a/Framework/PythonInterface/mantid/api/src/Exports/ITableWorkspace.cpp b/Framework/PythonInterface/mantid/api/src/Exports/ITableWorkspace.cpp index 4c3a6c8c43db11986c2483f550c2a65bd64ef589..853166f3094888aba80258dd77e561a5fbfe564b 100644 --- a/Framework/PythonInterface/mantid/api/src/Exports/ITableWorkspace.cpp +++ b/Framework/PythonInterface/mantid/api/src/Exports/ITableWorkspace.cpp @@ -338,67 +338,55 @@ void export_ITableWorkspace() { class_<ITableWorkspace, bases<Workspace>, boost::noncopyable>( "ITableWorkspace", iTableWorkspace_docstring.c_str(), no_init) - .def("addColumn", &addColumn, - (arg("self"), arg("type"), arg("name")), + .def("addColumn", &addColumn, (arg("self"), arg("type"), arg("name")), "Add a named column with the given type. Recognized types are: " "int,float,double,bool,str,V3D,long64") .def("removeColumn", &ITableWorkspace::removeColumn, - (arg("self"), arg("name")), - "Remove the named column") + (arg("self"), arg("name")), "Remove the named column") - .def("columnCount", &ITableWorkspace::columnCount, - arg("self"), + .def("columnCount", &ITableWorkspace::columnCount, arg("self"), "Returns the number of columns in the workspace") - .def("rowCount", &ITableWorkspace::rowCount, - arg("self"), + .def("rowCount", &ITableWorkspace::rowCount, arg("self"), "Returns the number of rows within the workspace") .def("setRowCount", &ITableWorkspace::setRowCount, (arg("self"), arg("count")), "Resize the table to contain count rows") - .def("__len__", &ITableWorkspace::rowCount, - arg("self"), + .def("__len__", &ITableWorkspace::rowCount, arg("self"), "Returns the number of rows within the workspace") - .def("getColumnNames", &ITableWorkspace::getColumnNames, - arg("self"), + .def("getColumnNames", &ITableWorkspace::getColumnNames, arg("self"), boost::python::return_value_policy<VectorToNumpy>(), "Return a list of the column names") - .def("keys", &ITableWorkspace::getColumnNames, - arg("self"), + .def("keys", &ITableWorkspace::getColumnNames, arg("self"), boost::python::return_value_policy<VectorToNumpy>(), "Return a list of the column names") - .def("column", &column, - (arg("self"), arg("column")), + .def("column", &column, (arg("self"), arg("column")), "Return all values of a specific column as a list") - .def("row", &row, - (arg("self"), arg("row")), + .def("row", &row, (arg("self"), arg("row")), "Return all values of a specific row as a dict") - .def("addRow", &addRowFromDict, - (arg("self"), arg("row_items_dict")), + .def("addRow", &addRowFromDict, (arg("self"), arg("row_items_dict")), "Appends a row with the values from the dictionary") - .def("addRow", &addRowFromList, - (arg("self"), arg("row_items_list")), + .def("addRow", &addRowFromList, (arg("self"), arg("row_items_list")), "Appends a row with the values from the given list. " "It it assumed that the items are in the correct order for the " "defined columns") - .def("cell", &cell, - (arg("self"), arg("value"), arg("row_or_column")), + .def("cell", &cell, (arg("self"), arg("value"), arg("row_or_column")), "Return the given cell. If the first argument is a " "number then it is interpreted as a row otherwise it " "is interpreted as a column name") - .def("setCell", &setCell, - (arg("self"), arg("row_or_column"), arg("column_or_row"), arg("value")), + .def("setCell", &setCell, (arg("self"), arg("row_or_column"), + arg("column_or_row"), arg("value")), "Sets the value of a given cell. If the first argument is a " "number then it is interpreted as a row otherwise it is interpreted " "as a column name"); diff --git a/Framework/PythonInterface/mantid/api/src/Exports/MDGeometry.cpp b/Framework/PythonInterface/mantid/api/src/Exports/MDGeometry.cpp index 8101365252b35e98fb841065ccd0648c237728f4..c739bc51666f77b172acb054c3266249488ec7d7 100644 --- a/Framework/PythonInterface/mantid/api/src/Exports/MDGeometry.cpp +++ b/Framework/PythonInterface/mantid/api/src/Exports/MDGeometry.cpp @@ -35,8 +35,7 @@ boost::python::list getNonIntegratedDimensionsAsPyList(const MDGeometry &self) { void export_MDGeometry() { class_<MDGeometry, boost::noncopyable>("MDGeometry", no_init) - .def("getNumDims", &MDGeometry::getNumDims, - arg("self"), + .def("getNumDims", &MDGeometry::getNumDims, arg("self"), "Returns the number of dimensions present") .def("getDimension", &MDGeometry::getDimension, @@ -52,47 +51,43 @@ void export_MDGeometry() { "Raises ValueError if the string is not a known id.") .def("getDimensionIndexByName", &MDGeometry::getDimensionIndexByName, - (arg("self"), arg("name")), "Returns the index of the dimension with the given " - "name. Raises RuntimeError if the name does not " - "exist.") + (arg("self"), arg("name")), + "Returns the index of the dimension with the given " + "name. Raises RuntimeError if the name does not " + "exist.") .def("getDimensionIndexById", &MDGeometry::getDimensionIndexById, - (arg("self"), arg("id")), "Returns the index of the dimension with the given " - "ID. Raises RuntimeError if the name does not exist.") + (arg("self"), arg("id")), + "Returns the index of the dimension with the given " + "ID. Raises RuntimeError if the name does not exist.") .def("getNonIntegratedDimensions", &getNonIntegratedDimensionsAsPyList, arg("self"), "Returns the description objects of the non-integrated dimension as " "a python list of IMDDimension.") - .def("estimateResolution", &MDGeometry::estimateResolution, - arg("self"), + .def("estimateResolution", &MDGeometry::estimateResolution, arg("self"), return_value_policy<VectorToNumpy>(), "Returns a numpy array containing the width of the smallest bin in " "each dimension") - .def("getXDimension", &MDGeometry::getXDimension, - arg("self"), + .def("getXDimension", &MDGeometry::getXDimension, arg("self"), return_value_policy<RemoveConstSharedPtr>(), "Returns the dimension description mapped to X") - .def("getYDimension", &MDGeometry::getYDimension, - arg("self"), + .def("getYDimension", &MDGeometry::getYDimension, arg("self"), return_value_policy<RemoveConstSharedPtr>(), "Returns the dimension description mapped to Y") - .def("getZDimension", &MDGeometry::getZDimension, - arg("self"), + .def("getZDimension", &MDGeometry::getZDimension, arg("self"), return_value_policy<RemoveConstSharedPtr>(), "Returns the dimension description mapped to Z") - .def("getTDimension", &MDGeometry::getTDimension, - arg("self"), + .def("getTDimension", &MDGeometry::getTDimension, arg("self"), return_value_policy<RemoveConstSharedPtr>(), "Returns the dimension description mapped to time") - .def("getGeometryXML", &MDGeometry::getGeometryXML, - arg("self"), + .def("getGeometryXML", &MDGeometry::getGeometryXML, arg("self"), "Returns an XML representation, as a string, of the geometry of the " "workspace") @@ -109,8 +104,7 @@ void export_MDGeometry() { "Returns True if there is a source workspace at the given index") .def("numOriginalWorkspaces", &MDGeometry::numOriginalWorkspaces, - arg("self"), - "Returns the number of source workspaces attached") + arg("self"), "Returns the number of source workspaces attached") .def("getOriginalWorkspace", &MDGeometry::getOriginalWorkspace, (arg("self"), arg("index")), @@ -118,20 +112,17 @@ void export_MDGeometry() { .def("getOrigin", (const Mantid::Kernel::VMD &(MDGeometry::*)() const) & MDGeometry::getOrigin, - arg("self"), - return_value_policy<copy_const_reference>(), + arg("self"), return_value_policy<copy_const_reference>(), "Returns the vector of the origin (in the original workspace) that " "corresponds to 0,0,0... in this workspace") .def("getNumberTransformsFromOriginal", - &MDGeometry::getNumberTransformsFromOriginal, - arg("self"), + &MDGeometry::getNumberTransformsFromOriginal, arg("self"), "Returns the number of transformations from original workspace " "coordinate systems") .def("getNumberTransformsToOriginal", - &MDGeometry::getNumberTransformsToOriginal, - arg("self"), + &MDGeometry::getNumberTransformsToOriginal, arg("self"), "Returns the number of transformations to original workspace " "coordinate systems") diff --git a/Framework/PythonInterface/mantid/api/src/Exports/MatrixWorkspace.cpp b/Framework/PythonInterface/mantid/api/src/Exports/MatrixWorkspace.cpp index ce09525b9b9f30a3dc9b156f571353f80cd9d62a..fe588b2413c841620fb3e83712b3a3be675b1145 100644 --- a/Framework/PythonInterface/mantid/api/src/Exports/MatrixWorkspace.cpp +++ b/Framework/PythonInterface/mantid/api/src/Exports/MatrixWorkspace.cpp @@ -150,12 +150,10 @@ void export_MatrixWorkspace() { boost::noncopyable>("MatrixWorkspace", no_init) //--------------------------------------- Meta information //----------------------------------------------------------------------- - .def("blocksize", &MatrixWorkspace::blocksize, - arg("self"), + .def("blocksize", &MatrixWorkspace::blocksize, arg("self"), "Returns size of the Y data array") .def("getNumberHistograms", &MatrixWorkspace::getNumberHistograms, - arg("self"), - "Returns the number of spectra in the workspace") + arg("self"), "Returns the number of spectra in the workspace") .def("binIndexOf", &MatrixWorkspace::binIndexOf, MatrixWorkspace_binIndexOfOverloads( (arg("self"), arg("xvalue"), arg("workspaceIndex")), @@ -171,12 +169,10 @@ void export_MatrixWorkspace() { "Returns the signed two theta value for given detector") .def("getSpectrum", (ISpectrum * (MatrixWorkspace::*)(const size_t)) & MatrixWorkspace::getSpectrum, - (arg("self"), arg("workspaceIndex")), - return_internal_reference<>(), + (arg("self"), arg("workspaceIndex")), return_internal_reference<>(), "Return the spectra at the given workspace index.") .def("getIndexFromSpectrumNumber", - &MatrixWorkspace::getIndexFromSpectrumNumber, - arg("self"), + &MatrixWorkspace::getIndexFromSpectrumNumber, arg("self"), "Returns workspace index correspondent to the given spectrum " "number. Throws if no such spectrum is present in the workspace") .def("getDetector", &MatrixWorkspace::getDetector, @@ -185,23 +181,19 @@ void export_MatrixWorkspace() { "Return the Detector or " "DetectorGroup that is linked to " "the given workspace index") - .def("getRun", &MatrixWorkspace::mutableRun, - arg("self"), + .def("getRun", &MatrixWorkspace::mutableRun, arg("self"), return_internal_reference<>(), "Return the Run object for this workspace") - .def("axes", &MatrixWorkspace::axes, - arg("self"), + .def("axes", &MatrixWorkspace::axes, arg("self"), "Returns the number of axes attached to the workspace") .def("getAxis", &MatrixWorkspace::getAxis, - (arg("self"), arg("axis_index")), - return_internal_reference<>(), - "Get a pointer to a workspace axis") + (arg("self"), arg("axis_index")), return_internal_reference<>(), + "Get a pointer to a workspace axis") .def("isHistogramData", &MatrixWorkspace::isHistogramData, arg("self"), "Returns True if this is considered to be binned data.") .def("isDistribution", (const bool &(MatrixWorkspace::*)() const) & MatrixWorkspace::isDistribution, - arg("self"), - return_value_policy<copy_const_reference>(), + arg("self"), return_value_policy<copy_const_reference>(), "Returns the status of the distribution flag") .def("YUnit", &MatrixWorkspace::YUnit, arg("self"), "Returns the current Y unit for the data (Y axis) in the workspace") @@ -212,8 +204,7 @@ void export_MatrixWorkspace() { .def("getNumberBins", &getNumberBinsDeprecated, arg("self"), "Returns size of the Y data array (deprecated, use blocksize " "instead)") - .def("getSampleDetails", &getSampleDetailsDeprecated, - arg("self"), + .def("getSampleDetails", &getSampleDetailsDeprecated, arg("self"), return_internal_reference<>(), "Return the Run object for this workspace (deprecated, use getRun " "instead)") @@ -228,8 +219,7 @@ void export_MatrixWorkspace() { "Sets a new unit for the data (Y axis) in the workspace") .def("setDistribution", (bool &(MatrixWorkspace::*)(const bool)) & MatrixWorkspace::isDistribution, - (arg("self"), arg("newVal")), - return_value_policy<return_by_value>(), + (arg("self"), arg("newVal")), return_value_policy<return_by_value>(), "Set distribution flag. If True the workspace has been divided by " "the bin-width.") .def("replaceAxis", &MatrixWorkspace::replaceAxis, @@ -239,11 +229,10 @@ void export_MatrixWorkspace() { //--------------------------------------- Read spectrum data //------------------------- .def("readX", &MatrixWorkspace::readX, - (arg("self"), arg("workspaceIndex")), - return_readonly_numpy(), + (arg("self"), arg("workspaceIndex")), return_readonly_numpy(), "Creates a read-only numpy wrapper " - "around the original X data at the " - "given index") + "around the original X data at the " + "given index") .def("readY", &MatrixWorkspace::readY, return_readonly_numpy(), args("self", "workspaceIndex"), "Creates a read-only numpy wrapper " "around the original Y data at the " diff --git a/Framework/PythonInterface/mantid/api/src/Exports/Projection.cpp b/Framework/PythonInterface/mantid/api/src/Exports/Projection.cpp index 40f96646efbdcdc69bdeb1ab496c98dacff2e03d..0973bf8190b35b423e6065bea29cadcf4c3531e4 100644 --- a/Framework/PythonInterface/mantid/api/src/Exports/Projection.cpp +++ b/Framework/PythonInterface/mantid/api/src/Exports/Projection.cpp @@ -114,14 +114,11 @@ void export_Projection() { "of u and v.") .def("__init__", make_constructor(&projCtor3), "Constructs a 3 dimensional projection") - .def("getOffset", &Projection::getOffset, - (arg("self"), arg("nd")), + .def("getOffset", &Projection::getOffset, (arg("self"), arg("nd")), "Returns the offset for the given dimension", args("dimension")) - .def("getAxis", &Projection::getAxis, - (arg("self"), arg("nd")), + .def("getAxis", &Projection::getAxis, (arg("self"), arg("nd")), "Returns the axis for the given dimension", args("dimension")) - .def("getType", &getUnit, - (arg("self"), arg("dimension")), + .def("getType", &getUnit, (arg("self"), arg("dimension")), "Returns the unit for the given dimension") .def("setOffset", &Projection::setOffset, (arg("self"), arg("nd"), arg("offset")), @@ -130,11 +127,9 @@ void export_Projection() { .def("setAxis", &Projection::setAxis, (arg("self"), arg("dimension"), arg("axis")), "Sets the axis for the given dimension") - .def("setAxis", &projSetAxis, - (arg("self"), arg("nd"), arg("data")), + .def("setAxis", &projSetAxis, (arg("self"), arg("nd"), arg("data")), "Sets the axis for the given dimension") - .def("setType", &setUnit, - (arg("self"), arg("dimension"), arg("unit")), + .def("setType", &setUnit, (arg("self"), arg("dimension"), arg("unit")), "Sets the unit for the given dimension") .add_property( "u", make_function(&Projection::U, return_internal_reference<>(), diff --git a/Framework/PythonInterface/mantid/api/src/Exports/Run.cpp b/Framework/PythonInterface/mantid/api/src/Exports/Run.cpp index 7c8767a982fa1e1134adda4b3689e3d3c4fcaf5b..e99ea1c92c6e0d9dc08f4d259d303021f0a32479 100644 --- a/Framework/PythonInterface/mantid/api/src/Exports/Run.cpp +++ b/Framework/PythonInterface/mantid/api/src/Exports/Run.cpp @@ -116,48 +116,39 @@ void export_Run() { // Run class class_<Run, boost::noncopyable>("Run", no_init) - .def("getProtonCharge", &Run::getProtonCharge, - arg("self"), + .def("getProtonCharge", &Run::getProtonCharge, arg("self"), "Return the total good proton charge for the run") - .def("integrateProtonCharge", &Run::integrateProtonCharge, - arg("self"), + .def("integrateProtonCharge", &Run::integrateProtonCharge, arg("self"), "Return the total good proton charge for the run") - .def("hasProperty", &Run::hasProperty, - (arg("self"), arg("name")), + .def("hasProperty", &Run::hasProperty, (arg("self"), arg("name")), "Returns True if the given log value is contained within the run") - .def("getProperty", &Run::getProperty, - (arg("self"), arg("name")), - return_value_policy<return_by_value>(), - "Returns the named property " - "(log value). Use '.value' " - "to return the value.") + .def("getProperty", &Run::getProperty, (arg("self"), arg("name")), + return_value_policy<return_by_value>(), "Returns the named property " + "(log value). Use '.value' " + "to return the value.") - .def("getProperties", &Run::getProperties, - arg("self"), + .def("getProperties", &Run::getProperties, arg("self"), return_internal_reference<>(), "Return the list of run properties managed by this object.") .def("getLogData", (Property * (Run::*)(const std::string &) const) & Run::getLogData, - (arg("self"), arg("name")), - return_value_policy<return_by_value>(), + (arg("self"), arg("name")), return_value_policy<return_by_value>(), "Returns the named log. Use '.value' to return the value. The same " "as getProperty.") .def("getLogData", (const std::vector<Property *> &(Run::*)() const) & Run::getLogData, - arg("self"), - return_internal_reference<>(), + arg("self"), return_internal_reference<>(), "Return the list of logs for this run. The same as getProperties.") .def("getGoniometer", (const Mantid::Geometry::Goniometer &(Run::*)() const) & Run::getGoniometer, - arg("self"), - return_value_policy<reference_existing_object>(), + arg("self"), return_value_policy<reference_existing_object>(), "Get the oriented lattice for this sample") .def("addProperty", &addProperty, @@ -167,7 +158,8 @@ void export_Run() { "existing property is overwritten") .def("addProperty", &addPropertyWithUnit, - (arg("self"), arg("name"), arg("value"), arg("units"), arg("replace")), + (arg("self"), arg("name"), arg("value"), arg("units"), + arg("replace")), "Adds a property with the given name, value and unit. If " "replace=True then an existing property is overwritten") @@ -175,25 +167,20 @@ void export_Run() { (arg("self"), arg("start"), arg("end")), "Set the start and end time of the run") - .def("startTime", &Run::startTime, - arg("self"), + .def("startTime", &Run::startTime, arg("self"), "Return the total starting time of the run.") - .def("endTime", &Run::endTime, - arg("self"), + .def("endTime", &Run::endTime, arg("self"), "Return the total ending time of the run.") //--------------------------- Dictionary // access---------------------------- - .def("get", &getWithDefault, - (arg("self"), arg("key"), arg("default")), + .def("get", &getWithDefault, (arg("self"), arg("key"), arg("default")), "Returns the value pointed to by the key or " - "None if it does not exist") - .def("get", &get, - (arg("self"), arg("key")), + "None if it does not exist") + .def("get", &get, (arg("self"), arg("key")), "Returns the value pointed to by the key or the default value given") - .def("keys", &keys, - arg("self"), + .def("keys", &keys, arg("self"), "Returns the names of the properties as list") .def("__contains__", &Run::hasProperty) .def("__getitem__", &Run::getProperty, diff --git a/Framework/PythonInterface/mantid/api/src/Exports/Sample.cpp b/Framework/PythonInterface/mantid/api/src/Exports/Sample.cpp index 61c76c586bf01807cca04154de60179a3515b44b..baa9826478dbad9a4c9ee7b2065d468a7cfedf01 100644 --- a/Framework/PythonInterface/mantid/api/src/Exports/Sample.cpp +++ b/Framework/PythonInterface/mantid/api/src/Exports/Sample.cpp @@ -16,56 +16,41 @@ void export_Sample() { class_<Sample, boost::noncopyable>("Sample", no_init) .def("getName", &Sample::getName, - return_value_policy<copy_const_reference>(), - arg("self"), + return_value_policy<copy_const_reference>(), arg("self"), "Returns the string name of the sample") .def("getOrientedLattice", (const OrientedLattice &(Sample::*)() const) & Sample::getOrientedLattice, - arg("self"), - return_value_policy<reference_existing_object>(), + arg("self"), return_value_policy<reference_existing_object>(), "Get the oriented lattice for this sample") - .def("hasOrientedLattice", &Sample::hasOrientedLattice, - arg("self"), + .def("hasOrientedLattice", &Sample::hasOrientedLattice, arg("self"), "Returns True if this sample has an oriented lattice, false " "otherwise") - .def("size", &Sample::size, - arg("self"), + .def("size", &Sample::size, arg("self"), "Return the number of samples contained within this sample") // Required for ISIS SANS reduction until the full sample geometry is // defined on loading - .def("getGeometryFlag", &Sample::getGeometryFlag, - arg("self"), + .def("getGeometryFlag", &Sample::getGeometryFlag, arg("self"), "Return the geometry flag.") - .def("getThickness", &Sample::getThickness, - arg("self"), - "Return the thickness in mm") - .def("getHeight", &Sample::getHeight, - arg("self"), - "Return the height in mm") - .def("getWidth", &Sample::getWidth, - arg("self"), - "Return the width in mm") + .def("getThickness", &Sample::getThickness, arg("self"), + "Return the thickness in mm") + .def("getHeight", &Sample::getHeight, arg("self"), + "Return the height in mm") + .def("getWidth", &Sample::getWidth, arg("self"), "Return the width in mm") .def("getMaterial", (const Material &(Sample::*)() const)(&Sample::getMaterial), - arg("self"), - return_value_policy<reference_existing_object>(), + arg("self"), return_value_policy<reference_existing_object>(), "The material the sample is composed of") .def("setGeometryFlag", &Sample::setGeometryFlag, - (arg("self"), arg("geom_id")), - "Set the geometry flag.") - .def("setThickness", &Sample::setThickness, - (arg("self"), arg("thick")), + (arg("self"), arg("geom_id")), "Set the geometry flag.") + .def("setThickness", &Sample::setThickness, (arg("self"), arg("thick")), "Set the thickness in mm.") - .def("setHeight", &Sample::setHeight, - (arg("self"), arg("height")), + .def("setHeight", &Sample::setHeight, (arg("self"), arg("height")), "Set the height in mm.") - .def("setWidth", &Sample::setWidth, - (arg("self"), arg("width")), + .def("setWidth", &Sample::setWidth, (arg("self"), arg("width")), "Set the width in mm.") // -------------------------Operators // ------------------------------------- - .def("__len__", &Sample::size, - arg("self"), + .def("__len__", &Sample::size, arg("self"), "Gets the number of samples in this collection") .def("__getitem__", &Sample::operator[], return_internal_reference<>()); } diff --git a/Framework/PythonInterface/mantid/api/src/Exports/ScriptRepository.cpp b/Framework/PythonInterface/mantid/api/src/Exports/ScriptRepository.cpp index 39d04431763060e6daa70bfdb7fe6c2705a2bc13..2422b6c7a81b3dace66d938011db87ac2ac29173 100644 --- a/Framework/PythonInterface/mantid/api/src/Exports/ScriptRepository.cpp +++ b/Framework/PythonInterface/mantid/api/src/Exports/ScriptRepository.cpp @@ -197,24 +197,14 @@ Arguments:\n\ class_<ScriptRepository, boost::noncopyable>("ScriptRepository", repo_desc, no_init) .def("install", &ScriptRepository::install, - (arg("self"), arg("local_path")), - install_desc) - .def("listFiles", &getListFiles, - arg("self"), - list_files_desc) - .def("fileInfo", &getInfo, - (arg("self"), arg("path")), - file_info_desc) - .def("description", &getDescription, - (arg("self"), arg("path")), - file_description_desc) - .def("fileStatus", &getStatus, - (arg("self"), arg("path")), - file_status_desc) + (arg("self"), arg("local_path")), install_desc) + .def("listFiles", &getListFiles, arg("self"), list_files_desc) + .def("fileInfo", &getInfo, (arg("self"), arg("path")), file_info_desc) + .def("description", &getDescription, (arg("self"), arg("path")), + file_description_desc) + .def("fileStatus", &getStatus, (arg("self"), arg("path")), + file_status_desc) .def("download", &ScriptRepository::download, - (arg("self"), arg("file_path")), - download_desc) - .def("update", &ScriptRepository::check4Update, - arg("self"), - update_desc); + (arg("self"), arg("file_path")), download_desc) + .def("update", &ScriptRepository::check4Update, arg("self"), update_desc); } diff --git a/Framework/PythonInterface/mantid/api/src/Exports/Workspace.cpp b/Framework/PythonInterface/mantid/api/src/Exports/Workspace.cpp index adda698911127e0873073a855ae779525fb15a31..79ad1d6ba6c907df9bc171ee771fe58c64245890 100644 --- a/Framework/PythonInterface/mantid/api/src/Exports/Workspace.cpp +++ b/Framework/PythonInterface/mantid/api/src/Exports/Workspace.cpp @@ -22,33 +22,26 @@ BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(Workspace_isDirtyOverloads, void export_Workspace() { class_<Workspace, bases<DataItem>, boost::noncopyable>("Workspace", no_init) .def("getName", &Workspace::getName, - return_value_policy<copy_const_reference>(), - arg("self"), + return_value_policy<copy_const_reference>(), arg("self"), "Returns the name of the workspace. This could be an empty string") - .def("getTitle", &Workspace::getTitle, - arg("self"), + .def("getTitle", &Workspace::getTitle, arg("self"), "Returns the title of the workspace") - .def("setTitle", &Workspace::setTitle, - (arg("self"), arg("title")), + .def("setTitle", &Workspace::setTitle, (arg("self"), arg("title")), "Set the title of the workspace") - .def("getComment", &Workspace::getComment, - arg("self"), + .def("getComment", &Workspace::getComment, arg("self"), return_value_policy<copy_const_reference>(), "Returns the comment field on the workspace") - .def("setComment", &Workspace::setComment, - (arg("self"), arg("comment")), + .def("setComment", &Workspace::setComment, (arg("self"), arg("comment")), "Set the comment field of the workspace") .def("isDirty", &Workspace::isDirty, Workspace_isDirtyOverloads(arg("n"), "True if the workspace has run " "more than n algorithms " "(Default=1)")) - .def("getMemorySize", &Workspace::getMemorySize, - arg("self"), + .def("getMemorySize", &Workspace::getMemorySize, arg("self"), "Returns the memory footprint of the workspace in KB") .def("getHistory", (const WorkspaceHistory &(Workspace::*)() const) & Workspace::getHistory, - arg("self"), - return_value_policy<reference_existing_object>(), + arg("self"), return_value_policy<reference_existing_object>(), "Return read-only access to the workspace history"); // register pointers diff --git a/Framework/PythonInterface/mantid/api/src/Exports/WorkspaceGroup.cpp b/Framework/PythonInterface/mantid/api/src/Exports/WorkspaceGroup.cpp index 7f587468bf776ce920d233898f4cd530a297aa0e..8c15d0331d17f326bcc93695ee46b4d083c8f017 100644 --- a/Framework/PythonInterface/mantid/api/src/Exports/WorkspaceGroup.cpp +++ b/Framework/PythonInterface/mantid/api/src/Exports/WorkspaceGroup.cpp @@ -13,32 +13,26 @@ void export_WorkspaceGroup() { class_<WorkspaceGroup, bases<Workspace>, boost::noncopyable>("WorkspaceGroup", no_init) .def("getNumberOfEntries", &WorkspaceGroup::getNumberOfEntries, - arg("self"), - "Returns the number of entries in the group") - .def("getNames", &WorkspaceGroup::getNames, - arg("self"), + arg("self"), "Returns the number of entries in the group") + .def("getNames", &WorkspaceGroup::getNames, arg("self"), "Returns the names of the entries in the group") .def("contains", (bool (WorkspaceGroup::*)(const std::string &wsName) const) & WorkspaceGroup::contains, (arg("self"), arg("workspace")), "Returns true if the given name is in the group") - .def("add", &WorkspaceGroup::add, - (arg("self"), arg("workspace_name")), - "Add a name to the group") - .def("size", &WorkspaceGroup::size, - arg("self"), + .def("add", &WorkspaceGroup::add, (arg("self"), arg("workspace_name")), + "Add a name to the group") + .def("size", &WorkspaceGroup::size, arg("self"), "Returns the number of workspaces contained in the group") .def("remove", &WorkspaceGroup::remove, - (arg("self"), arg("workspace_name")), - "Remove a name from the group") + (arg("self"), arg("workspace_name")), "Remove a name from the group") .def("getItem", (Workspace_sptr (WorkspaceGroup::*)(const size_t) const) & WorkspaceGroup::getItem, (arg("self"), arg("workspace_name")), return_value_policy<Policies::ToWeakPtr>(), "Returns the item at the given index") - .def("isMultiPeriod", &WorkspaceGroup::isMultiperiod, - arg("self"), + .def("isMultiPeriod", &WorkspaceGroup::isMultiperiod, arg("self"), "Retuns true if the workspace group is multi-period") // ------------ Operators -------------------------------- .def("__len__", &WorkspaceGroup::getNumberOfEntries) diff --git a/Framework/PythonInterface/mantid/api/src/Exports/WorkspaceHistory.cpp b/Framework/PythonInterface/mantid/api/src/Exports/WorkspaceHistory.cpp index a7f06384b81d7c0caf2c6c4ec442b3479b9f91e0..9a32321b85fe93b711c88e770ae089e673720b86 100644 --- a/Framework/PythonInterface/mantid/api/src/Exports/WorkspaceHistory.cpp +++ b/Framework/PythonInterface/mantid/api/src/Exports/WorkspaceHistory.cpp @@ -38,8 +38,7 @@ void export_WorkspaceHistory() { class_<WorkspaceHistory, boost::noncopyable>("WorkspaceHistory", no_init) - .def("getAlgorithmHistories", &getHistoriesAsList, - arg("self"), + .def("getAlgorithmHistories", &getHistoriesAsList, arg("self"), "Returns a list of algorithm histories for this workspace history.") .def("getAlgorithmHistory", &WorkspaceHistory::getAlgorithmHistory, @@ -47,16 +46,13 @@ void export_WorkspaceHistory() { return_value_policy<Policies::RemoveConstSharedPtr>(), "Returns the algorithm history at the given index in the history") - .def("size", &WorkspaceHistory::size, - arg("self"), + .def("size", &WorkspaceHistory::size, arg("self"), "Returns the number of algorithms in the immediate history") - .def("empty", &WorkspaceHistory::empty, - arg("self"), + .def("empty", &WorkspaceHistory::empty, arg("self"), "Returns whether the history has any entries") - .def("lastAlgorithm", &WorkspaceHistory::lastAlgorithm, - arg("self"), + .def("lastAlgorithm", &WorkspaceHistory::lastAlgorithm, arg("self"), "Returns the last algorithm run on this workspace so that its " "properties can be accessed")