SourceXtractorPlusPlus 0.21
SourceXtractor++, the next generation SExtractor
Loading...
Searching...
No Matches
FlexibleModelFittingIterativeTask.cpp
Go to the documentation of this file.
1
22
26
28
32
38
42
43namespace SourceXtractor {
44
45using namespace ModelFitting;
46
47static auto logger = Elements::Logging::getLogger("FlexibleModelFitting");
48
64
67
68namespace {
69
71 auto fitting_rect = source.getProperty<MeasurementFrameRectangle>(frame_index).getRect();
72
73 if (fitting_rect.getWidth() <= 0 || fitting_rect.getHeight() <= 0) {
74 return PixelRectangle();
75 } else {
76 const auto& frame_info = source.getProperty<MeasurementFrameInfo>(frame_index);
77
78 auto min = fitting_rect.getTopLeft();
79 auto max = fitting_rect.getBottomRight();
80
81 // FIXME temporary, for now just enlarge the area by a fixed amount of pixels
82 PixelCoordinate border = (max - min) * .8 + PixelCoordinate(2, 2);
83
84 min -= border;
85 max += border;
86
87 // clip to image size
88 min.m_x = std::max(min.m_x, 0);
89 min.m_y = std::max(min.m_y, 0);
90 max.m_x = std::min(max.m_x, frame_info.getWidth() - 1);
91 max.m_y = std::min(max.m_y, frame_info.getHeight() - 1);
92
93 return PixelRectangle(min, max);
94 }
95}
96
97bool isFrameValid(SourceInterface& source, int frame_index) {
99 return stamp_rect.getWidth() > 0 && stamp_rect.getHeight() > 0;
100}
101
102std::shared_ptr<VectorImage<SeFloat>> createImageCopy(SourceInterface& source, int frame_index) {
103 const auto& frame_images = source.getProperty<MeasurementFrameImages>(frame_index);
105
107 LayerSubtractedImage, rect.getTopLeft().m_x, rect.getTopLeft().m_y, rect.getWidth(), rect.getHeight()));
108
109 return image;
110}
111
112std::shared_ptr<VectorImage<SeFloat>> createWeightImage(SourceInterface& source, int frame_index) {
113 const auto& frame_images = source.getProperty<MeasurementFrameImages>(frame_index);
114 auto frame_image = frame_images.getLockedImage(LayerSubtractedImage);
116 auto variance_map = frame_images.getLockedImage(LayerVarianceMap);
117
118 const auto& frame_info = source.getProperty<MeasurementFrameInfo>(frame_index);
119 SeFloat gain = frame_info.getGain();
120 SeFloat saturation = frame_info.getSaturation();
121
123 auto weight = VectorImage<SeFloat>::create(rect.getWidth(), rect.getHeight());
124
125 for (int y = 0; y < rect.getHeight(); y++) {
126 for (int x = 0; x < rect.getWidth(); x++) {
127 auto back_var = variance_map->getValue(rect.getTopLeft().m_x + x, rect.getTopLeft().m_y + y);
128 auto pixel_val = frame_image->getValue(rect.getTopLeft().m_x + x, rect.getTopLeft().m_y + y);
129 if (saturation > 0 && pixel_val > saturation) {
130 weight->at(x, y) = 0;
131 }
132 else if (gain > 0.0 && pixel_val > 0.0) {
133 weight->at(x, y) = sqrt(1.0 / (back_var + pixel_val / gain));
134 }
135 else {
136 weight->at(x, y) = sqrt(1.0 / back_var); // infinite gain
137 }
138 }
139 }
140
141
142 return weight;
143}
144
146 SourceInterface& source, double pixel_scale, FlexibleModelFittingParameterManager& manager,
148
149 int frame_index = frame->getFrameNb();
150
151 auto frame_coordinates = source.getProperty<MeasurementFrameCoordinates>(frame_index).getCoordinateSystem();
152 auto ref_coordinates = source.getProperty<ReferenceCoordinates>().getCoordinateSystem();
153
154 auto psf_property = source.getProperty<SourcePsfProperty>(frame_index);
155 auto jacobian = source.getProperty<JacobianSource>(frame_index).asTuple();
156
157 // The model fitting module expects to get a PSF with a pixel scale, but we have the pixel sampling step size
158 // It will be used to compute the rastering grid size, and after convolving with the PSF the result will be
159 // downscaled before copied into the frame image.
160 // We can multiply here then, as the unit is pixel/pixel, rather than "/pixel or similar
161 auto source_psf = DownSampledImagePsf(psf_property.getPixelSampling(), psf_property.getPsf(), down_scaling);
162
166
167 double model_size = std::max(stamp_rect.getWidth(), stamp_rect.getHeight());
168 for (auto model : frame->getModels()) {
171 }
172
173 // Full frame model with all sources
175 pixel_scale, (size_t) stamp_rect.getWidth(), (size_t) stamp_rect.getHeight(),
177
178 return frame_model;
179}
180
181}
182
183
186
187 for (auto& source : group) {
190 initial_state.iterations = 0;
191 initial_state.stop_reason = 0;
192 initial_state.reduced_chi_squared = 0.0;
193 initial_state.duration = 0.0;
194
195 for (auto parameter : m_parameters) {
197 if (free_parameter != nullptr) {
198 initial_state.parameters_initial_values[free_parameter->getId()] =
199 initial_state.parameters_values[free_parameter->getId()] = free_parameter->getInitialValue(source);
200 } else {
201 initial_state.parameters_initial_values[parameter->getId()] =
202 initial_state.parameters_values[parameter->getId()] = 0.0;
203 }
204 // Make sure we have a default value for sigmas in case we cannot do the fit
205 initial_state.parameters_sigmas[parameter->getId()] = std::numeric_limits<double>::quiet_NaN();
206 }
207 fitting_state.source_states.emplace_back(std::move(initial_state));
208 }
209
210 // TODO Sort sources by flux to fit brightest sources first?
211
212 // iterate over the whole group, fitting sources one at a time
213
214 double prev_chi_squared = 999999.9;
215 for (int iteration = 0; iteration < m_meta_iterations; iteration++) {
216 int index = 0;
217 for (auto& source : group) {
219 index++;
220 }
221
222 // evaluate reduced chi squared to bail out of meta iterations if no longer improving the fit
223
224 double chi_squared = 0.0;
225 for (auto& source_state : fitting_state.source_states) {
226 chi_squared += source_state.reduced_chi_squared;
227 }
228 chi_squared /= fitting_state.source_states.size();
229
231 break;
232 }
233
235 }
236
237
238 // Remove parameters that couldn't be fit from the output
239
240 for (size_t index = 0; index < group.size(); index++){
241 auto& source_state = fitting_state.source_states.at(index);
242
243 for (auto parameter : m_parameters) {
245
246 if (free_parameter != nullptr && !source_state.parameters_fitted[parameter->getId()]) {
247 source_state.parameters_values[parameter->getId()] = std::numeric_limits<double>::quiet_NaN();
248 source_state.parameters_sigmas[parameter->getId()] = std::numeric_limits<double>::quiet_NaN();
249 }
250 }
251 }
252
253 // output a property for every source
254 size_t index = 0;
255 for (auto& source : group) {
256 auto& source_state = fitting_state.source_states.at(index);
257
258 int meta_iterations = source_state.chi_squared_per_meta.size();
259 source_state.chi_squared_per_meta.resize(m_meta_iterations);
260 source_state.iterations_per_meta.resize(m_meta_iterations);
261
262 source.setProperty<FlexibleModelFitting>(source_state.iterations, source_state.stop_reason,
263 source_state.reduced_chi_squared, source_state.duration, source_state.flags,
264 source_state.parameters_values, source_state.parameters_sigmas,
265 source_state.chi_squared_per_meta, source_state.iterations_per_meta,
267
268 index++;
269 }
270
272}
273
274
278 int frame_index = frame->getFrameNb();
280
281 double pixel_scale = 1.0;
284 int n_free_parameters = 0;
285
286 int index = 0;
287 for (auto& src : group) {
288 if (index != source_index) {
289 for (auto parameter : m_parameters) {
291
292 if (free_parameter != nullptr) {
294
295 // Initial with the values from the current iteration run
296 parameter_manager.addParameter(src, parameter,
298 state.source_states[index].parameters_initial_values.at(free_parameter->getId()),
299 state.source_states[index].parameters_values.at(free_parameter->getId())));
300
301 } else {
302 parameter_manager.addParameter(src, parameter,
304 }
305 }
306 }
307 index++;
308 }
309
310 auto deblend_image = VectorImage<SeFloat>::create(rect.getWidth(), rect.getHeight());
311 index = 0;
312 for (auto& src : group) {
313 if (index != source_index) {
314 auto frame_model = createFrameModel(src, pixel_scale, parameter_manager, frame, rect);
315 auto final_stamp = frame_model.getImage();
316
317 for (int y = 0; y < final_stamp->getHeight(); ++y) {
318 for (int x = 0; x < final_stamp->getWidth(); ++x) {
319 deblend_image->at(x, y) += final_stamp->at(x, y);
320 }
321 }
322 }
323 index++;
324 }
325
326 return deblend_image;
327}
328
332 SourceInterface& source, int index, FittingState& state) const {
333 int free_parameters_nb = 0;
334 for (auto parameter : m_parameters) {
336
337 if (free_parameter != nullptr) {
339
340 // Initial with the values from the current iteration run
341 parameter_manager.addParameter(source, parameter,
343 state.source_states[index].parameters_initial_values.at(free_parameter->getId()),
344 state.source_states[index].parameters_values.at(free_parameter->getId())));
345 } else {
346 parameter_manager.addParameter(source, parameter,
348 }
349
350 }
351
352 // Reset access checks, as a dependent parameter could have triggered it
353 parameter_manager.clearAccessCheck();
354
355 return free_parameters_nb;
356}
357
360 SourceGroupInterface& group, SourceInterface& source, int index, FittingState& state, double down_scaling) const {
361
362 double pixel_scale = 1.0;
363
364 int valid_frames = 0;
365 for (auto frame : m_frames) {
366 int frame_index = frame->getFrameNb();
367 // Validate that each frame covers the model fitting region
368 if (isFrameValid(source, frame_index)) {
369 valid_frames++;
370
373
374 auto image = createImageCopy(source, frame_index);
375
376 auto deblend_image = createDeblendImage(group, source, index, frame, state);
377 for (int y = 0; y < image->getHeight(); ++y) {
378 for (int x = 0; x < image->getWidth(); ++x) {
379 image->at(x, y) -= m_deblend_factor * deblend_image->at(x, y);
380 }
381 }
382
383 auto weight = createWeightImage(source, frame_index);
384
385 // count number of pixels that can be used for fitting
386 for (int y = 0; y < weight->getHeight(); ++y) {
387 for (int x = 0; x < weight->getWidth(); ++x) {
388 good_pixels += (weight->at(x, y) != 0.);
389 }
390 }
391
392 // Setup residuals
393 auto data_vs_model =
395 //LogChiSquareComparator(m_modified_chi_squared_scale));
397 res_estimator.registerBlockProvider(std::move(data_vs_model));
398 }
399 }
400
401 return valid_frames;
402}
403
424
427 SeFloat avg_reduced_chi_squared, SeFloat duration, unsigned int iterations, unsigned int stop_reason, Flags flags,
429 int index, FittingState& state) const {
431 // Collect parameters for output
432 std::unordered_map<int, double> parameters_values, parameters_sigmas;
433 std::unordered_map<int, bool> parameters_fitted;
434
435 for (auto parameter : m_parameters) {
440
442 parameters_values[parameter->getId()] = modelfitting_parameter->getValue();
443 parameters_sigmas[parameter->getId()] = parameter->getSigma(parameter_manager, source, solution.parameter_sigmas);
444 parameters_fitted[parameter->getId()] = true;
445 } else {
446 parameters_values[parameter->getId()] = state.source_states[index].parameters_values[parameter->getId()];
447 parameters_sigmas[parameter->getId()] = state.source_states[index].parameters_sigmas[parameter->getId()];
448 parameters_fitted[parameter->getId()] = false;
449
450 // Need to cascade the NaN to any potential dependent parameter
452 if (engine_parameter) {
454 }
455
456 flags |= Flags::PARTIAL_FIT;
457 }
458 }
459
460 state.source_states[index].parameters_values = parameters_values;
461 state.source_states[index].parameters_sigmas = parameters_sigmas;
462 state.source_states[index].parameters_fitted = parameters_fitted;
463 state.source_states[index].reduced_chi_squared = avg_reduced_chi_squared;
464 state.source_states[index].chi_squared_per_meta.emplace_back(avg_reduced_chi_squared);
465 state.source_states[index].duration += duration;
466 state.source_states[index].iterations += iterations;
467 state.source_states[index].iterations_per_meta.emplace_back(iterations);
468 state.source_states[index].stop_reason = stop_reason;
469 state.source_states[index].flags = flags;
470}
471
473
475 // Determine size of fitted area and if needed downsize factor
476
477 double fit_size = 0;
478 for (auto frame : m_frames) {
479 int frame_index = frame->getFrameNb();
480 // Validate that each frame covers the model fitting region
481 if (isFrameValid(source, frame_index)) {
484 fit_size = std::max(fit_size, stamp_rect.getWidth() * stamp_rect.getHeight() /
485 (psf_property.getPixelSampling() * psf_property.getPixelSampling()));
486 }
487 }
488
490 if (fit_size > m_max_fit_size * 2.0) {
492 logger.warn() << "Exceeding max fit size: " << fit_size << " / " << m_max_fit_size
493 << " scaling factor: " << down_scaling;
494 }
495
497 // Prepare parameters
498
503
505 // Add models for all frames
507 int n_good_pixels = 0;
510
512 // Check that we had enough data for the fit
513
514 Flags flags = Flags::NONE;
515
516 if (valid_frames == 0) {
517 flags = Flags::OUTSIDE;
518 }
519 else if (n_good_pixels < n_free_parameters) {
521 }
522
523 // Do not run the model fitting for the flags above
524 if (flags != Flags::NONE) {
525 return;
526 }
527
528 if (down_scaling < 1.0) {
529 flags |= Flags::DOWNSAMPLED;
530 }
531
532
534 // Add priors
535 for (auto prior : m_priors) {
537 }
538
540 // Model fitting
541
544
545 auto iterations = solution.iteration_no;
546 auto stop_reason = solution.engine_stop_reason;
547 if (solution.status_flag == LeastSquareSummary::ERROR) {
548 flags |= Flags::ERROR;
549 }
550 auto duration = solution.duration;
551
553 // compute chi squared
554
556
558 // update state with results
559 fitSourceUpdateState(parameter_manager, source, avg_reduced_chi_squared, duration, iterations, stop_reason, flags, solution,
560 index, state);
561}
562
564 double pixel_scale, FittingState& state) const {
565
566 // recreate parameters
567
570
571 int index = 0;
572 for (auto& src : group) {
573 for (auto parameter : m_parameters) {
575
576 if (free_parameter != nullptr) {
577 // Initialize with the values from the current iteration run
578 parameter_manager.addParameter(src, parameter,
580 state.source_states[index].parameters_initial_values.at(free_parameter->getId()),
581 state.source_states[index].parameters_values.at(free_parameter->getId())));
582 } else {
583 parameter_manager.addParameter(src, parameter,
585 }
586 }
587 index++;
588 }
589
590 for (auto& src : group) {
591 for (auto frame : m_frames) {
592 int frame_index = frame->getFrameNb();
593
594 if (isFrameValid(src, frame_index)) {
596
597 auto frame_model = createFrameModel(src, pixel_scale, parameter_manager, frame, stamp_rect);
598 auto final_stamp = frame_model.getImage();
599
600 auto debug_image = CheckImages::getInstance().getModelFittingImage(frame_index);
601 if (debug_image) {
603 for (int x = 0; x < final_stamp->getWidth(); x++) {
604 for (int y = 0; y < final_stamp->getHeight(); y++) {
605 auto x_coord = stamp_rect.getTopLeft().m_x + x;
606 auto y_coord = stamp_rect.getTopLeft().m_y + y;
607 debug_image->setValue(x_coord, y_coord,
608 debugAccessor.getValue(x_coord, y_coord) + final_stamp->getValue(x, y));
609 }
610 }
611 }
612
613 }
614 }
615 }
616}
617
620 double reduced_chi_squared = 0.0;
621 data_points = 0;
622
625
626 for (int y=0; y < image->getHeight(); y++) {
627 for (int x=0; x < image->getWidth(); x++) {
628 double tmp = imageAccessor.getValue(x, y) - modelAccessor.getValue(x, y);
629 reduced_chi_squared += tmp * tmp * weightAccessor.getValue(x, y) * weightAccessor.getValue(x, y);
630 if (weightAccessor.getValue(x, y) > 0) {
631 data_points++;
632 }
633 }
634 }
635 return reduced_chi_squared;
636}
637
642 int valid_frames = 0;
643 for (auto frame : m_frames) {
644 int frame_index = frame->getFrameNb();
645 // Validate that each frame covers the model fitting region
646 if (isFrameValid(source, frame_index)) {
647 valid_frames++;
649 auto frame_model = createFrameModel(source, pixel_scale, manager, frame, stamp_rect);
650 auto final_stamp = frame_model.getImage();
651
652 auto image = createImageCopy(source, frame_index);
653 auto deblend_image = createDeblendImage(group, source, index, frame, state);
654 for (int y = 0; y < image->getHeight(); ++y) {
655 for (int x = 0; x < image->getWidth(); ++x) {
656 image->at(x, y) -= deblend_image->at(x, y);
657 }
658 }
659
660 auto weight = createWeightImage(source, frame_index);
661
662 int data_points = 0;
664
667 }
668 }
669
670 return total_chi_squared;
671}
672
673}
674
675
676
std::shared_ptr< DependentParameter< std::shared_ptr< EngineParameter > > > x
std::shared_ptr< DependentParameter< std::shared_ptr< EngineParameter > > > y
const double pixel_scale
Definition TestImage.cpp:74
static Logging getLogger(const std::string &name="")
void warn(const std::string &logMessage)
Data vs model comparator which computes a modified residual, using asinh.
Class responsible for managing the parameters the least square engine minimizes.
static std::shared_ptr< LeastSquareEngine > create(const std::string &name, unsigned max_iterations=1000)
Provides to the LeastSquareEngine the residual values.
static CheckImages & getInstance()
void fitSourceUpdateState(FlexibleModelFittingParameterManager &parameter_manager, SourceInterface &source, SeFloat avg_reduced_chi_squared, SeFloat duration, unsigned int iterations, unsigned int stop_reason, Flags flags, ModelFitting::LeastSquareSummary solution, int index, FittingState &state) const
void fitSource(SourceGroupInterface &group, SourceInterface &source, int index, FittingState &state) const
int fitSourcePrepareParameters(FlexibleModelFittingParameterManager &parameter_manager, ModelFitting::EngineParameterManager &engine_parameter_manager, SourceInterface &source, int index, FittingState &state) const
void computeProperties(SourceGroupInterface &group) const override
Computes one or more properties for the SourceGroup and/or the Sources it contains.
SeFloat fitSourceComputeChiSquared(FlexibleModelFittingParameterManager &parameter_manager, SourceGroupInterface &group, SourceInterface &source, int index, FittingState &state) const
std::vector< std::shared_ptr< FlexibleModelFittingFrame > > m_frames
std::shared_ptr< VectorImage< SeFloat > > createDeblendImage(SourceGroupInterface &group, SourceInterface &source, int source_index, std::shared_ptr< FlexibleModelFittingFrame > frame, FittingState &state) const
int fitSourcePrepareModels(FlexibleModelFittingParameterManager &parameter_manager, ModelFitting::ResidualEstimator &res_estimator, int &good_pixels, SourceGroupInterface &group, SourceInterface &source, int index, FittingState &state, double downscaling) const
FlexibleModelFittingIterativeTask(const std::string &least_squares_engine, unsigned int max_iterations, double modified_chi_squared_scale, std::vector< std::shared_ptr< FlexibleModelFittingParameter > > parameters, std::vector< std::shared_ptr< FlexibleModelFittingFrame > > frames, std::vector< std::shared_ptr< FlexibleModelFittingPrior > > priors, double scale_factor=1.0, int meta_iterations=3, double deblend_factor=1.0, double meta_iteration_stop=0.0001, size_t max_fit_size=100)
std::vector< std::shared_ptr< FlexibleModelFittingParameter > > m_parameters
SeFloat computeChiSquared(SourceGroupInterface &group, SourceInterface &source, int index, double pixel_scale, FlexibleModelFittingParameterManager &manager, int &total_data_points, FittingState &state) const
SeFloat computeChiSquaredForFrame(std::shared_ptr< const Image< SeFloat > > image, std::shared_ptr< const Image< SeFloat > > model, std::shared_ptr< const Image< SeFloat > > weights, int &data_points) const
void updateCheckImages(SourceGroupInterface &group, double pixel_scale, FittingState &state) const
std::vector< std::shared_ptr< FlexibleModelFittingPrior > > m_priors
Defines the interface used to group sources.
The SourceInterface is an abstract "source" that has properties attached to it.
static std::shared_ptr< VectorImage< T > > create(Args &&... args)
T fabs(T... args)
T max(T... args)
T min(T... args)
T move(T... args)
static Elements::Logging logger
std::unique_ptr< DataVsModelResiduals< typename std::remove_reference< DataType >::type, typename std::remove_reference< ModelType >::type, typename std::remove_reference< WeightType >::type, typename std::remove_reference< Comparator >::type > > createDataVsModelResiduals(DataType &&data, ModelType &&model, WeightType &&weight, Comparator &&comparator)
Flags
Flagging of bad sources.
Definition SourceFlags.h:37
@ DOWNSAMPLED
The fit was done on a downsampled image due to exceeding max size.
@ OUTSIDE
The object is completely outside of the measurement frame.
@ NONE
No flag is set.
@ ERROR
Error flag: something bad happened during the measurement, model fitting, etc.
@ INSUFFICIENT_DATA
There are not enough good pixels to fit the parameters.
@ PARTIAL_FIT
Some/all of the model parameters could not be fitted.
@ LayerVarianceMap
Definition Frame.h:45
@ LayerThresholdedImage
Definition Frame.h:41
@ LayerSubtractedImage
Definition Frame.h:39
SeFloat32 SeFloat
Definition Types.h:32
T quiet_NaN(T... args)
T sqrt(T... args)
Class containing the summary information of solving a least square minimization problem.