76const std::string LOG_CHARGE_NAME(
"proton_charge");
78const std::vector<std::string> binningModeNames{
"Logarithmic",
"Linear"};
82const std::vector<std::string> unitNames{
"dSpacing",
"TOF",
"MomentumTransfer"};
83enum class BinUnit { DSPACE,
TOF, Q, enum_count };
86const size_t NUM_HIST{6};
88const std::string ENTRY_TOP_LEVEL(
"entry");
91double getFocussedPostion(
const detid_t detid,
const std::vector<double> &difc_focus,
92 std::map<detid_t, size_t> &detIDToSpecNum) {
93 if (detIDToSpecNum.contains(detid)) {
94 return difc_focus[detIDToSpecNum[detid]];
100std::vector<double> calculate_difc_focused(
const double l1,
const std::vector<double> &l2s,
101 const std::vector<double> &polars) {
102 constexpr double deg2rad = std::numbers::pi_v<double> / 180.;
104 std::vector<double>
difc;
106 std::transform(l2s.cbegin(), l2s.cend(), polars.cbegin(), std::back_inserter(
difc),
107 [l1,
deg2rad](
const auto &
l2,
const auto &polar) {
108 return 1. / Kernel::Units::tofToDSpacingFactor(l1, l2, deg2rad * polar, 0.);
132 return "VULCAN ONLY Algorithm to focus powder diffraction data into a number of histograms according to a grouping "
133 "scheme defined in a CalFile.";
142 const std::vector<std::string> exts{
".nxs.h5",
".nxs",
"_event.nxs"};
145 "The name of the Event NeXus file to read, including its full or relative path. "
146 "The file name is typically of the form INST_####_event.nxs.");
149 "To only include events after the provided start time, in seconds (relative to the start of the run).");
153 "To only include events before the provided stop time, in seconds (relative to the start of the run).");
156 "Input workspace specifying \"splitters\", i.e. time intervals and targets for event filtering. "
157 "Currently only a single output workspace is supported.");
159 "Flag indicating whether in SplitterWorkspace the times are absolute or "
160 "relative. If true, they are relative to the run start time.");
163 "For development testing. Changes how the splitters are processed. If true then use ProcessBankSplitTask "
164 "otherwise loop over ProcessBankTask.");
166 "Find time-of-flight when neutron was at the sample position. This is only necessary for fast logs "
167 "(i.e. more frequent than proton on target pulse).");
170 "If true, events will be splitting using full time values (tof+pulsetime) rather than just pulsetime.");
171 auto mustBePositive = std::make_shared<BoundedValidator<int>>();
172 mustBePositive->setLower(0);
174 "Filter bad pulses in the same way that :ref:`algm-FilterBadPulses` does.");
175 auto range = std::make_shared<BoundedValidator<double>>();
176 range->setBounds(0., 100.);
178 "The percentage of the average to use as the lower bound when filtering bad pulses.");
181 "A GroupingWorkspace giving the grouping info. If not provided then the grouping from the "
182 "calibration file will be used if provided, else a default grouping of one group per bank.");
183 const std::vector<std::string> cal_exts{
".h5",
".hd5",
".hdf",
".cal"};
185 "The .cal file containing the position correction factors. Either this or OffsetsWorkspace needs to "
187 auto mustBePosArr = std::make_shared<Kernel::ArrayBoundedValidator<double>>();
188 mustBePosArr->setLower(0.0);
190 "Minimum x-value for the output binning");
192 "Bin size for output data");
194 "Minimum x-value for the output binning");
196 "The units of the input X min, max and delta values. Output will always be TOF");
198 "Specify binning behavior ('Logarithmic')");
200 "If specified, only these logs will be loaded from the file");
202 "If specified, these logs will not be loaded from the file");
205 "An output workspace.");
208 const std::string CHUNKING_PARAM_GROUP(
"Chunking-temporary");
209 auto positiveIntValidator = std::make_shared<Mantid::Kernel::BoundedValidator<int>>();
210 positiveIntValidator->setLower(1);
213 "Number of elements of time-of-flight or detector-id to read at a time. This is a maximum");
217 "Number of events to read in a single thread. Higher means less threads are created.");
223 "The bank for which to read data; if specified, others will be blank");
227 auto mandatoryDblValidator = std::make_shared<MandatoryValidator<double>>();
228 auto positiveDblValidator = std::make_shared<Mantid::Kernel::BoundedValidator<double>>();
229 positiveDblValidator->setLower(0);
230 auto l1Validator = std::make_shared<CompositeValidator>();
231 l1Validator->add(mandatoryDblValidator);
232 l1Validator->add(positiveDblValidator);
234 auto mandatoryDblArrayValidator = std::make_shared<MandatoryValidator<std::vector<double>>>();
235 auto positionArrayValidator = std::make_shared<CompositeValidator>();
236 positionArrayValidator->add(mandatoryDblArrayValidator);
237 positionArrayValidator->add(mustBePosArr);
239 "The primary distance :math:`\\ell_1` from beam to sample");
242 "The secondary distances :math:`\\ell_2` from sample to focus group");
245 "The effective polar angle (:math:`2\\theta`) of each focus group");
248 "The effective azimuthal angle :math:`\\phi` for each focus group");
252 std::map<std::string, std::string> errors;
257 if (disk_chunk < grainsize_events) {
272 const auto num_l2s = l2s.size();
275 errors[
PropertyNames::L2] = strmakef(
"L2S has inconsistent length %zu", num_l2s);
281 if (num_l2s != phi.size()) {
282 errors[
PropertyNames::L2] = strmakef(
"L2S has inconsistent length %zu", num_l2s);
293 const auto numMin = xmins.size();
294 const auto numMax = xmaxs.size();
295 const auto numDelta = deltas.size();
297 if (std::any_of(deltas.cbegin(), deltas.cend(), [](
double d) { return !std::isfinite(d) || d == 0; }))
299 else if (!(numDelta == 1 || numDelta == num_l2s))
302 if (!(numMin == 1 || numMin == num_l2s))
304 if (!(numMax == 1 || numMax == num_l2s))
317 if (filename.find(
"VULCAN") == std::string::npos) {
318 throw std::runtime_error(
"File does not appear to be for VULCAN");
328 std::map<size_t, std::set<detid_t>> grouping;
335 LoadEventNexus::loadInstrument<MatrixWorkspace_sptr>(filename, inst_ws, ENTRY_TOP_LEVEL,
this, &descriptor);
340 if (!cal_filename.empty()) {
341 calibrationWS = this->
loadCalFile(inst_ws, cal_filename, groupingWS);
345 const auto groupIds = groupingWS->getGroupIDs(
false);
346 num_hist = groupIds.size();
347 g_log.
information() <<
"Using grouping workspace with " << num_hist <<
" groups\n";
348 for (
size_t outputSpecNum = 0; outputSpecNum < groupIds.size(); ++outputSpecNum) {
349 const auto detids = groupingWS->getDetectorIDsOfGroup(groupIds[outputSpecNum]);
350 grouping[outputSpecNum] = std::set<detid_t>(detids.begin(), detids.end());
357 this->
progress(.0,
"Create output workspace");
366 std::vector<double> setPhi(l2s.size(), 0.0);
370 const std::vector<double> azimuthals(setPhi);
371 const std::vector<specnum_t> specids;
372 const auto difc_focused = calculate_difc_focused(l1, l2s, polars);
375 this->
progress(.01,
"Loading metadata");
379 }
catch (std::exception &e) {
380 g_log.
warning() <<
"Error while loading meta data: " << e.what() <<
'\n';
384 this->
progress(.02,
"Loading logs");
385 auto periodLog = std::make_unique<const TimeSeriesProperty<int>>(
"period_log");
389 LoadEventNexus::runLoadNexusLogs<MatrixWorkspace_sptr>(filename, wksp, *
this,
false, nPeriods, periodLog, allow_logs,
395 this->
progress(.05,
"Determining pulse indices");
398 const std::map<std::string, std::set<std::string>> &allEntries = descriptor.
getAllEntries();
399 auto itClassEntries = allEntries.find(
"NXevent_data");
403 if (itClassEntries == allEntries.end()) {
405 throw std::runtime_error(
"No NXevent_data entries found in file");
408 this->
progress(.07,
"Reading events");
411 std::vector<std::string> bankEntryNames;
412 std::size_t num_banks_to_read;
416 for (
size_t i = 1; i <= NUM_HIST; ++i) {
419 num_banks_to_read = NUM_HIST;
422 for (
size_t i = 1; i <= NUM_HIST; ++i) {
423 bankEntryNames.push_back(
"");
426 bankEntryNames[outputSpecNum - 1] =
"bank" +
std::to_string(outputSpecNum) +
"_events";
427 num_banks_to_read = 1;
431 std::map<size_t, std::set<detid_t>> bank_detids;
432 for (
size_t i = 1; i <= NUM_HIST; ++i) {
433 bank_detids[i - 1] = wksp->getInstrument()->getDetectorIDsInBank(
"bank" +
std::to_string(i));
437 if (!grouping.empty()) {
438 for (
const auto &
group : grouping) {
439 for (
const auto &detid :
group.second) {
445 grouping[0] = std::set<detid_t>{};
446 for (
const auto &[i, detids] : bank_detids) {
447 grouping[0].insert(detids.begin(), detids.end());
448 for (
const auto &detid : detids) {
455 this->
progress(.1,
"Creating calibration constants");
468 this->
progress(.15,
"Set instrument geometry");
472 this->
progress(.17,
"Convert bins to TOF");
481 g_log.
debug() << (DISK_CHUNK / GRAINSIZE_EVENTS) <<
" threads per chunk\n";
485 if (!frequency_log) {
486 throw std::runtime_error(
"Frequency log not found in workspace run");
488 m_pulse_times = std::make_shared<std::vector<Mantid::Types::Core::DateAndTime>>(frequency_log->timesAsVector());
490 if (timeSplitter.empty()) {
495 auto loader = std::make_shared<NexusLoader>(
is_time_filtered, pulse_indices);
497 auto progress = std::make_shared<API::Progress>(
this, .17, .9, num_banks_to_read);
498 ProcessBankTask task(bankEntryNames, h5file, loader, processingData, calibFactory,
static_cast<size_t>(DISK_CHUNK),
499 static_cast<size_t>(GRAINSIZE_EVENTS),
progress);
501 if (num_banks_to_read > 1) {
502 tbb::parallel_for(tbb::blocked_range<size_t>(0, num_banks_to_read), task);
505 task(tbb::blocked_range<size_t>(outputSpecNum - 1, outputSpecNum));
515 wksp->mutableRun().setTimeROI(filterROI);
516 wksp->mutableRun().removeDataOutsideTimeROI();
521 std::vector<std::string> wsNames;
522 std::vector<int> workspaceIndices;
523 std::vector<MatrixWorkspace_sptr> workspaces;
524 std::vector<SpectraProcessingData> processingDatas;
525 for (
const int &splitter_target : timeSplitter.outputWorkspaceIndices()) {
526 std::string ws_name = ws_basename +
"_" + timeSplitter.getWorkspaceIndexName(splitter_target);
527 wsNames.push_back(std::move(ws_name));
528 workspaceIndices.push_back(splitter_target);
529 workspaces.emplace_back(wksp->clone());
533 auto progress = std::make_shared<API::Progress>(
this, .17, .9, num_banks_to_read * workspaceIndices.size());
535 g_log.
information() <<
"Using ProcessBankSplitFullTimeTask for splitter processing\n";
540 if (!filterROI.useAll()) {
541 combined_time_roi.update_intersection(filterROI);
546 auto loader = std::make_shared<NexusLoader>(
is_time_filtered, pulse_indices);
548 const auto &splitterMap = timeSplitter.getSplittersMap();
551 static_cast<size_t>(DISK_CHUNK),
static_cast<size_t>(GRAINSIZE_EVENTS),
555 if (num_banks_to_read > 1) {
556 tbb::parallel_for(tbb::blocked_range<size_t>(0, num_banks_to_read), task);
559 task(tbb::blocked_range<size_t>(outputSpecNum - 1, outputSpecNum));
563 g_log.
information() <<
"Using ProcessBankSplitTask for splitter processing\n";
567 std::vector<PulseROI> pulse_indices;
568 auto loader = std::make_shared<NexusLoader>(
is_time_filtered, pulse_indices, target_to_pulse_indices);
570 ProcessBankSplitTask task(bankEntryNames, h5file, loader, workspaceIndices, processingDatas, calibFactory,
571 static_cast<size_t>(DISK_CHUNK),
static_cast<size_t>(GRAINSIZE_EVENTS),
progress);
573 if (num_banks_to_read > 1) {
574 tbb::parallel_for(tbb::blocked_range<size_t>(0, num_banks_to_read), task);
577 task(tbb::blocked_range<size_t>(outputSpecNum - 1, outputSpecNum));
583 tbb::blocked_range<size_t>(0, workspaceIndices.size()),
584 [&](
const tbb::blocked_range<size_t> &target_indices) {
585 for (size_t target_index = target_indices.begin(); target_index != target_indices.end(); ++target_index) {
586 const int splitter_target = workspaceIndices[target_index];
588 auto splitter_roi = timeSplitter.getTimeROI(splitter_target);
590 auto target_roi = filterROI;
591 if (target_roi.useAll())
592 target_roi = std::move(splitter_roi);
593 else if (!splitter_roi.useAll())
594 target_roi.update_intersection(splitter_roi);
597 MatrixWorkspace_sptr target_wksp = workspaces[target_index];
599 const auto pulse_indices = this->determinePulseIndices(target_roi);
600 auto loader = std::make_shared<NexusLoader>(is_time_filtered, pulse_indices);
602 ProcessBankTask task(bankEntryNames, h5file, loader, processingDatas[target_index], calibFactory,
603 static_cast<size_t>(DISK_CHUNK), static_cast<size_t>(GRAINSIZE_EVENTS), progress);
605 if (num_banks_to_read > 1) {
606 tbb::parallel_for(tbb::blocked_range<size_t>(0, num_banks_to_read), task);
609 task(tbb::blocked_range<size_t>(outputSpecNum - 1, outputSpecNum));
619 for (
size_t idx = 0; idx < workspaceIndices.size(); ++idx) {
624 auto target_roi = timeSplitter.getTimeROI(workspaceIndices[idx]);
625 if (target_roi.useAll())
626 target_roi = filterROI;
627 else if (!filterROI.useAll())
628 target_roi.update_intersection(filterROI);
631 workspaces[idx]->mutableRun().setTimeROI(target_roi);
632 workspaces[idx]->mutableRun().removeDataOutsideTimeROI();
633 AnalysisDataService::Instance().addOrReplace(wsNames[idx], workspaces[idx]);
638 groupws->setAlwaysStoreInADS(
true);
639 groupws->setProperty(
"InputWorkspaces", wsNames);
640 groupws->setProperty(
"OutputWorkspace", ws_basename);
643 if (!groupws->isExecuted()) {
644 throw std::runtime_error(
"Failed to group output workspaces");
657 const bool linearBins = bool(binmode == BinningMode::LINEAR);
658 const std::string binUnits = getPropertyValue(PropertyNames::BIN_UNITS);
659 std::vector<double> x_delta = getProperty(PropertyNames::X_DELTA);
660 std::vector<double> x_min = getProperty(PropertyNames::X_MIN);
661 std::vector<double> x_max = getProperty(PropertyNames::X_MAX);
662 const bool raggedBins = (x_delta.size() != 1 || x_min.size() != 1 || x_max.size() != 1);
664 constexpr bool resize_xnew{
true};
665 constexpr bool full_bins_only{
false};
668 HistogramData::BinEdges XValues(0);
670 const std::vector<double> params{x_min[0], x_delta[0], x_max[0]};
674 const std::vector<double> params{x_min[0], -1. * x_delta[0], x_max[0]};
682 if (x_delta.size() == 1)
683 x_delta.resize(num_hist, x_delta[0]);
684 if (x_min.size() == 1)
685 x_min.resize(num_hist, x_min[0]);
686 if (x_max.size() == 1)
687 x_max.resize(num_hist, x_max[0]);
689 for (
size_t i = 1; i < num_hist; ++i) {
690 HistogramData::BinEdges XValues_new(0);
693 const std::vector<double> params{x_min[i], x_delta[i], x_max[i]};
697 const std::vector<double> params{x_min[i], -1. * x_delta[i], x_max[i]};
701 HistogramData::Histogram hist(XValues_new, HistogramData::Counts(XValues_new.size() - 1, 0.0));
702 wksp->setHistogram(i, hist);
706 wksp->getAxis(0)->setUnit(binUnits);
707 wksp->setYUnit(
"Counts");
715 const size_t numSpectra = outputWS->getNumberHistograms();
716 for (
size_t i = 0; i < numSpectra; ++i) {
717 const auto &spectrum = outputWS->getSpectrum(i);
718 processingData.
binedges.emplace_back(&spectrum.readX());
719 processingData.
counts.emplace_back(spectrum.dataY().size());
721 return processingData;
726 const size_t numSpectra = outputWS->getNumberHistograms();
727 for (
size_t i = 0; i < numSpectra; ++i) {
728 auto &spectrum = outputWS->getSpectrum(i);
729 auto &y_values = spectrum.dataY();
731 processingData.
counts[i].cbegin(), processingData.
counts[i].cend(), y_values.begin(),
732 [](
const std::atomic_uint32_t &val) { return static_cast<double>(val.load(std::memory_order_relaxed)); });
733 auto &e_values = spectrum.dataE();
734 std::transform(processingData.
counts[i].cbegin(), processingData.
counts[i].cend(), e_values.begin(),
735 [](
const std::atomic_uint32_t &val) {
736 return std::sqrt(static_cast<double>(val.load(std::memory_order_relaxed)));
742 const std::vector<double> &difc_focus) {
743 const auto detInfo = wksp->detectorInfo();
745 for (
auto iter = detInfo.cbegin(); iter != detInfo.cend(); ++iter) {
746 if (!iter->isMonitor()) {
747 const auto difc_focussed = getFocussedPostion(
static_cast<detid_t>(iter->detid()), difc_focus, detIDToSpecNum);
751 m_calibration.emplace(
static_cast<detid_t>(iter->detid()),
752 difc_focussed / detInfo.difcUncalibrated(iter->index()));
757void AlignAndFocusPowderSlim::initCalibrationConstantsFromCalWS(
const std::vector<double> &difc_focus,
759 for (
size_t row = 0; row < calibrationWS->rowCount(); ++row) {
760 const detid_t detid = calibrationWS->cell<
int>(row, 0);
761 const double detc = calibrationWS->cell<
double>(row, 1);
762 const auto difc_focussed = getFocussedPostion(detid, difc_focus, detIDToSpecNum);
766 m_calibration.emplace(detid, difc_focussed / detc);
771 const std::string &filename,
773 const bool load_grouping = !groupingWS;
775 auto alg = createChildAlgorithm(
"LoadDiffCal");
776 alg->setProperty(
"InputWorkspace", inputWS);
777 alg->setPropertyValue(
"Filename", filename);
778 alg->setProperty<
bool>(
"MakeCalWorkspace",
true);
779 alg->setProperty<
bool>(
"MakeGroupingWorkspace", load_grouping);
780 alg->setProperty<
bool>(
"MakeMaskWorkspace",
true);
781 alg->setPropertyValue(
"WorkspaceName",
"temp");
782 alg->executeAsChildAlg();
785 g_log.
debug() <<
"Loading grouping workspace from calibration file\n";
786 groupingWS = alg->getProperty(
"OutputGroupingWorkspace");
792 m_masked = maskWS->getMaskedDetectors();
793 g_log.
debug() <<
"Masked detectors: " << m_masked.size() <<
'\n';
795 return calibrationWS;
804 const auto detInfo = wksp->detectorInfo();
806 const double L1 = detInfo.l1();
808 if (this->getProperty(PropertyNames::CORRECTION_TO_SAMPLE)) {
810 for (
auto iter = detInfo.cbegin(); iter != detInfo.cend(); ++iter) {
811 if (!iter->isMonitor()) {
812 const double path_correction = L1 / (L1 + iter->l2()) * 1000.0;
813 m_scale_at_sample.emplace(
static_cast<detid_t>(iter->detid()), path_correction);
818 for (
auto iter = detInfo.cbegin(); iter != detInfo.cend(); ++iter) {
819 if (!iter->isMonitor()) {
820 m_scale_at_sample.emplace(
static_cast<detid_t>(iter->detid()), 1000.0);
828 const std::vector<specnum_t> &specids,
const std::vector<double> &l2s,
const std::vector<double> &azimuthals) {
830 editAlg->setLoggingOffset(1);
831 editAlg->setProperty(
"Workspace", wksp);
833 editAlg->setProperty(
"PrimaryFlightPath", l1);
835 editAlg->setProperty(
"Polar", polars);
836 if (!specids.empty())
837 editAlg->setProperty(
"SpectrumIDs", specids);
839 editAlg->setProperty(
"L2", l2s);
840 if (!azimuthals.empty())
841 editAlg->setProperty(
"Azimuthal", azimuthals);
842 editAlg->executeAsChildAlg();
844 wksp = editAlg->getProperty(
"Workspace");
850 if (wksp->getAxis(0)->unit()->unitID() ==
"TOF") {
856 convertUnits->setProperty(
"InputWorkspace", wksp);
857 convertUnits->setPropertyValue(
"Target",
"TOF");
858 convertUnits->executeAsChildAlg();
859 wksp = convertUnits->getProperty(
"OutputWorkspace");
873 const auto startOfRun = wksp->run().startTime();
876 double filter_time_start_sec = getProperty(PropertyNames::FILTER_TIMESTART);
877 double filter_time_stop_sec = getProperty(PropertyNames::FILTER_TIMESTOP);
879 this->progress(.15,
"Creating time filtering");
880 g_log.
information() <<
"Filtering pulses from " << filter_time_start_sec <<
" to " << filter_time_stop_sec <<
"s\n";
883 roi.
addROI(startOfRun + (filter_time_start_sec ==
EMPTY_DBL() ? 0.0 : filter_time_start_sec),
884 startOfRun + filter_time_stop_sec);
885 }
catch (
const std::runtime_error &e) {
886 throw std::invalid_argument(
"Invalid time range for filtering: " + std::string(e.what()));
891 if (getProperty(PropertyNames::FILTER_BAD_PULSES)) {
892 this->progress(.16,
"Filtering bad pulses");
895 const auto [min_pcharge, max_pcharge, mean] =
896 wksp->run().getBadPulseRange(LOG_CHARGE_NAME, getProperty(PropertyNames::FILTER_BAD_PULSES_LOWER_CUTOFF));
897 g_log.
information() <<
"Filtering bad pulses; pcharge outside of " << min_pcharge <<
" to " << max_pcharge <<
'\n';
899 const auto run_start = wksp->getFirstPulseTime();
900 const auto run_stop = wksp->getLastPulseTime();
918std::vector<PulseROI> AlignAndFocusPowderSlim::determinePulseIndices(
const TimeROI &filterROI) {
920 std::vector<PulseROI> pulse_indices;
922 pulse_indices.emplace_back(0, std::numeric_limits<size_t>::max());
924 is_time_filtered =
true;
926 if (pulse_indices.empty())
927 throw std::invalid_argument(
"No valid pulse time indices found for filtering");
930 return pulse_indices;
941std::vector<std::pair<int, PulseROI>>
942AlignAndFocusPowderSlim::determinePulseIndicesTargets(
const TimeROI &filterROI,
const TimeSplitter &timeSplitter) {
943 std::vector<PulseROI> pulse_indices;
945 pulse_indices.emplace_back(0, std::numeric_limits<size_t>::max());
948 if (pulse_indices.empty())
949 throw std::invalid_argument(
"No valid pulse time indices found for filtering");
955 std::vector<std::pair<int, PulseROI>> intersected_target_pulse_indices;
956 auto pulse_it = pulse_indices.cbegin();
957 for (
const auto &target_pair : target_to_pulse_indices) {
959 while (pulse_it != pulse_indices.cend() && pulse_it->second <= target_pair.second.first) {
963 auto check_it = pulse_it;
964 while (check_it != pulse_indices.cend() && check_it->first < target_pair.second.second) {
966 size_t start_index = std::max(check_it->first, target_pair.second.first);
967 size_t stop_index = std::min(check_it->second, target_pair.second.second);
968 if (start_index < stop_index) {
969 intersected_target_pulse_indices.emplace_back(target_pair.first,
PulseROI(start_index, stop_index));
975 return intersected_target_pulse_indices;
979AlignAndFocusPowderSlim::timeSplitterFromSplitterWorkspace(
const Types::Core::DateAndTime &filterStartTime) {
982 std::dynamic_pointer_cast<DataObjects::SplittersWorkspace>(tempws);
984 std::dynamic_pointer_cast<DataObjects::TableWorkspace>(tempws);
987 if (!splittersWorkspace && !splitterTableWorkspace && !matrixSplitterWS)
990 const bool isSplittersRelativeTime = this->getProperty(PropertyNames::SPLITTER_RELATIVE);
993 if (splittersWorkspace) {
995 }
else if (splitterTableWorkspace) {
997 TimeSplitter(splitterTableWorkspace, isSplittersRelativeTime ? filterStartTime : DateAndTime::GPS_EPOCH);
999 time_splitter =
TimeSplitter(matrixSplitterWS, isSplittersRelativeTime ? filterStartTime : DateAndTime::GPS_EPOCH);
1002 return time_splitter;
#define DECLARE_ALGORITHM(classname)
#define UNUSED_ARG(x)
Function arguments are sometimes unused in certain implmentations but are required for documentation ...
void declareProperty(std::unique_ptr< Kernel::Property > p, const std::string &doc="") override
Add a property to the list of managed properties.
std::string getPropertyValue(const std::string &name) const override
Get the value of a property as a string.
TypedValue getProperty(const std::string &name) const override
Get the value of a property.
virtual std::shared_ptr< Algorithm > createChildAlgorithm(const std::string &name, const double startProgress=-1., const double endProgress=-1., const bool enableLogging=true, const int &version=-1)
Create a Child Algorithm.
void progress(double p, const std::string &msg="", double estimatedTime=0.0, int progressPrecision=0)
Sends ProgressNotification.
bool isDefault(const std::string &name) const
A specialized class for dealing with file properties.
@ OptionalLoad
to specify a file to read but the file doesn't have to exist
@ Load
allowed here which will be passed to the algorithm
A property class for workspaces.
Base Workspace Abstract Class.
AlignAndFocusPowderSlim : TODO: DESCRIPTION.
std::vector< int64_t > loadSize
How much to load in the file.
const std::string summary() const override
Algorithm's summary for use in the GUI and help.
API::MatrixWorkspace_sptr createOutputWorkspace(const Geometry::Instrument_const_sptr inst, size_t num_hist)
std::vector< std::pair< size_t, size_t > > determinePulseIndices(const Kernel::TimeROI &filterROI)
Determine the pulse indices for a given workspace and time ROI.
std::map< std::string, std::string > validateInputs() override
Perform validation of ALL the input properties of the algorithm.
SpectraProcessingData initializeSpectraProcessingData(const API::MatrixWorkspace_sptr &outputWS)
std::vector< int64_t > loadStart
Index to load start at in the file.
std::shared_ptr< std::vector< Types::Core::DateAndTime > > m_pulse_times
std::map< detid_t, double > m_calibration
detid: 1/difc
void storeSpectraProcessingData(const SpectraProcessingData &processingData, const API::MatrixWorkspace_sptr &outputWS)
void init() override
Initialize the algorithm's properties.
std::set< detid_t > m_masked
DataObjects::TimeSplitter timeSplitterFromSplitterWorkspace(const Types::Core::DateAndTime &)
std::map< detid_t, size_t > detIDToSpecNum
std::map< detid_t, double > m_scale_at_sample
Multiplicative 0<value<1 to move neutron TOF at sample.
void initScaleAtSample(const API::MatrixWorkspace_sptr &wksp)
For fast logs, calculate the sample position correction.
const std::string category() const override
Algorithm's category for identification.
std::vector< std::pair< int, std::pair< size_t, size_t > > > determinePulseIndicesTargets(const Kernel::TimeROI &filterROI, const DataObjects::TimeSplitter &timeSplitter)
Determine the pulse indices for a given workspace, time ROI, and time splitter.
API::MatrixWorkspace_sptr editInstrumentGeometry(API::MatrixWorkspace_sptr &wksp, const double l1, const std::vector< double > &polars, const std::vector< specnum_t > &specids, const std::vector< double > &l2s, const std::vector< double > &azimuthals)
int version() const override
Algorithm's version for identification.
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso (these are not validated) algorithms related to this algorithm....
void initCalibrationConstantsFromCalWS(const std::vector< double > &difc_focus, const API::ITableWorkspace_sptr calibrationWS)
const API::ITableWorkspace_sptr loadCalFile(const API::Workspace_sptr &inputWS, const std::string &filename, DataObjects::GroupingWorkspace_sptr &groupingWS)
Kernel::TimeROI getFilterROI(const API::MatrixWorkspace_sptr &wksp)
Create a TimeROI based on the filtering properties set in the algorithm.
API::MatrixWorkspace_sptr convertToTOF(API::MatrixWorkspace_sptr &wksp)
void exec() override
Execute the algorithm.
void initCalibrationConstants(API::MatrixWorkspace_sptr &wksp, const std::vector< double > &difc_focus)
static void loadEntryMetadata(const std::string &nexusfilename, T WS, const std::string &entry_name, const Nexus::NexusDescriptor &descriptor)
Load the run number and other meta data from the given bank.
std::vector< std::pair< int, std::pair< size_t, size_t > > > calculate_target_indices(const std::vector< DateAndTime > ×) const
Given a list of times, calculate the corresponding indices in the TimeSplitter.
Concrete workspace implementation.
Kernel/ArrayBoundedValidator.h.
Support for a property that holds an array of values.
BoundedValidator is a validator that requires the values to be between upper or lower bounds,...
A concrete property based on user options of a finite list of strings.
IPropertyManager * setProperty(const std::string &name, const T &value)
Templated method to set the value of a PropertyWithValue.
void setPropertyGroup(const std::string &name, const std::string &group)
Set the group for a given property.
void debug(const std::string &msg)
Logs at debug level.
void warning(const std::string &msg)
Logs at warning level.
void information(const std::string &msg)
Logs at information level.
Validator to check that a property is not left empty.
The concrete, templated class for properties.
static T & Instance()
Return a reference to the Singleton instance, creating it if it does not already exist Creation is do...
Represents a time interval.
TimeROI : Object that holds information about when the time measurement was active.
std::vector< std::pair< size_t, size_t > > calculate_indices(const std::vector< Types::Core::DateAndTime > ×) const
void addROI(const std::string &startTime, const std::string &stopTime)
bool useAll() const
TimeROI selects all time to be used.
A specialised Property class for holding a series of time-value pairs.
const std::map< std::string, std::set< std::string > > & getAllEntries() const noexcept
Returns a const reference of the internal map holding all entries in the Nexus HDF5 file.
std::shared_ptr< IAlgorithm > IAlgorithm_sptr
shared pointer to Mantid::API::IAlgorithm
std::shared_ptr< ITableWorkspace > ITableWorkspace_sptr
shared pointer to Mantid::API::ITableWorkspace
std::shared_ptr< Workspace > Workspace_sptr
shared pointer to Mantid::API::Workspace
Mantid::Kernel::SingletonHolder< AnalysisDataServiceImpl > AnalysisDataService
Kernel::Logger g_log("ExperimentInfo")
static logger object
std::shared_ptr< MatrixWorkspace > MatrixWorkspace_sptr
shared pointer to the matrix workspace base class
const std::string GROUPING_WS("GroupingWorkspace")
const std::string FILTER_TIMESTART("FilterByTimeStart")
const std::string AZIMUTHALS("Azimuthal")
const std::string CAL_FILE("CalFileName")
const std::string FILTER_BAD_PULSES_LOWER_CUTOFF("BadPulsesLowerCutoff")
const std::string OUTPUT_SPEC_NUM("OutputSpectrumNumber")
const std::string ALLOW_LOGS("LogAllowList")
const std::string SPLITTER_RELATIVE("RelativeTime")
const std::string PROCESS_BANK_SPLIT_TASK("ProcessBankSplitTask")
const std::string OUTPUT_WKSP("OutputWorkspace")
const std::string CORRECTION_TO_SAMPLE("CorrectionToSample")
const std::string BIN_UNITS("BinningUnits")
const std::string FILTER_TIMESTOP("FilterByTimeStop")
const std::string L2("L2")
const std::string BLOCK_LOGS("LogBlockList")
const std::string X_DELTA("XDelta")
const std::string X_MIN("XMin")
const std::string FILENAME("Filename")
const std::string POLARS("Polar")
const std::string BINMODE("BinningMode")
const std::string SPLITTER_WS("SplitterWorkspace")
const std::string EVENTS_PER_THREAD("EventsPerThread")
const std::string FILTER_BAD_PULSES("FilterBadPulses")
const std::string X_MAX("XMax")
const std::string FULL_TIME("UseFullTime")
const std::string L1("L1")
const std::string READ_SIZE_FROM_DISK("ReadSizeFromDisk")
std::pair< size_t, size_t > PulseROI
const int64_t PULSETIME_OFFSET
constexpr double IGNORE_PIXEL
std::shared_ptr< SplittersWorkspace > SplittersWorkspace_sptr
std::shared_ptr< TableWorkspace > TableWorkspace_sptr
shared pointer to Mantid::DataObjects::TableWorkspace
std::shared_ptr< GroupingWorkspace > GroupingWorkspace_sptr
shared pointer to the GroupingWorkspace class
std::shared_ptr< MaskWorkspace > MaskWorkspace_sptr
shared pointer to the MaskWorkspace class
constexpr double deg2rad
Defines units/enum for Crystal work.
std::shared_ptr< const Instrument > Instrument_const_sptr
Shared pointer to an const instrument object.
MANTID_KERNEL_DLL std::string strmakef(char const *const fmt,...)
This is the constructor that std::string needed to have.
int MANTID_KERNEL_DLL createAxisFromRebinParams(const std::vector< double > ¶ms, std::vector< double > &xnew, const bool resize_xnew=true, const bool full_bins_only=false, const double xMinHint=std::nan(""), const double xMaxHint=std::nan(""), const bool useReverseLogarithmic=false, const double power=-1)
Creates a new output X array given a 'standard' set of rebinning parameters.
MANTID_NEXUS_DLL H5::FileAccPropList defaultFileAcc()
Default file access is H5F_CLOSE_STRONG.
const std::string BINMODE("BinningMode")
constexpr int EMPTY_INT() noexcept
Returns what we consider an "empty" integer within a property.
int32_t detid_t
Typedef for a detector ID.
constexpr double EMPTY_DBL() noexcept
Returns what we consider an "empty" double within a property.
std::string to_string(const wide_integer< Bits, Signed > &n)
std::vector< std::vector< std::atomic_uint32_t > > counts
std::vector< const std::vector< double > * > binedges
Describes the direction (within an algorithm) of a Property.
@ Input
An input workspace.
@ Output
An output workspace.