Welcome to the mirar documentation!
mirar is a modular, flexible, open-source code to reduce analyse and astronomy images, built using python 3.10. It was created by Robert Stein and Viraj Karambelkar (see everyone who contributed at Contributors).
How does mirar work? Check out About.
How can you install mirar? You can find instructions at Installation.
How can you use mirar? Have a look at Usage, where there is a guide with examples.
Want to use mirar for your own telescope? Great! Have a look at our Contributing Guide. This also describes what to do if you find a bug or want to request a new feature.
What does x piece of mirar do? See the full documentation at mirar.
Contents
- About
- Installation
- Usage
- Contributors
- Contributing Guide
- mirar
- mirar package
- Subpackages
- mirar.catalog package
- Subpackages
- mirar.catalog.kowalski package
- mirar.catalog.vizier package
- Submodules
- mirar.catalog.base_catalog module
- mirar.catalog.gaia module
- Subpackages
- mirar.data package
- mirar.downloader package
- mirar.errors package
- mirar.monitor package
- mirar.pipelines package
PipelineConfigErrorget_pipeline()- Subpackages
- mirar.pipelines.sedmv2 package
- mirar.pipelines.summer package
- mirar.pipelines.winter package
- Subpackages
- Submodules
- mirar.pipelines.winter.blocks module
- mirar.pipelines.winter.build_references module
- mirar.pipelines.winter.constants module
- mirar.pipelines.winter.fix_headers module
- mirar.pipelines.winter.generator module
ReductionQualityErrorcheck_winter_local_catalog_overlap()ref_sextractor()select_winter_flat_images()winter_astrometric_ref_catalog_generator()winter_astrometric_ref_catalog_namer()winter_astrometry_sextractor_catalog_purifier()winter_astrostat_catalog_purifier()winter_candidate_annotator_filterer()winter_candidate_avro_fields_calculator()winter_candidate_quality_filterer()winter_fourier_filtered_image_generator()winter_photometric_catalog_generator()winter_photometric_ref_catalog_namer()winter_ref_catalog_namer()winter_ref_photometric_img_catalog_purifier()winter_reference_generator()winter_reference_image_resampler_for_zogy()winter_reference_phot_calibrator()winter_reference_psfex()winter_reference_sextractor()winter_reference_stack_annotator()winter_stackid_annotator()winter_wfau_component_image_stacker()
- mirar.pipelines.winter.load_winter_image module
- mirar.pipelines.winter.winter_pipeline module
- mirar.pipelines.wirc package
- Submodules
- mirar.pipelines.base_pipeline module
PipelinePipeline.add_configuration()Pipeline.all_pipeline_configurationsPipeline.configure_processors()Pipeline.default_cal_requirementsPipeline.download_raw_images_for_night()Pipeline.get_error_output_path()Pipeline.load_pipeline_configuration()Pipeline.load_raw_image()Pipeline.namePipeline.non_linear_levelPipeline.pipelinesPipeline.postprocess_configuration()Pipeline.reduce_images()Pipeline.set_configuration()Pipeline.unpack_raw_image()
- mirar.processors package
- Subpackages
- mirar.processors.alerts package
- mirar.processors.astromatic package
- Subpackages
- mirar.processors.astromatic.config package
- mirar.processors.astromatic.psfex package
- mirar.processors.astromatic.scamp package
- mirar.processors.astromatic.sextractor package
- mirar.processors.astromatic.swarp package
- Subpackages
- mirar.processors.astrometry package
- Subpackages
- mirar.processors.astrometry.anet package
- mirar.processors.astrometry.autoastrometry package
- Submodules
- mirar.processors.astrometry.autoastrometry.autoastrometry module
- mirar.processors.astrometry.autoastrometry.autoastrometry_processor module
- mirar.processors.astrometry.autoastrometry.crossmatch module
- mirar.processors.astrometry.autoastrometry.detect module
- mirar.processors.astrometry.autoastrometry.errors module
- mirar.processors.astrometry.autoastrometry.io module
- mirar.processors.astrometry.autoastrometry.reference module
- mirar.processors.astrometry.autoastrometry.sources module
- mirar.processors.astrometry.autoastrometry.utils module
- Submodules
- mirar.processors.astrometry.utils module
- mirar.processors.astrometry.validate module
- Subpackages
- mirar.processors.candidates package
- Subpackages
- Submodules
- mirar.processors.candidates.bright_star_mask module
- mirar.processors.candidates.candidate_detector module
- mirar.processors.candidates.candidate_extractor module
- mirar.processors.candidates.candidate_filter module
- mirar.processors.candidates.edge_mask module
- mirar.processors.candidates.namer module
- mirar.processors.database package
- Submodules
- mirar.processors.database.base_database_processor module
- mirar.processors.database.constraints module
- mirar.processors.database.database_exporter module
- mirar.processors.database.database_importer module
- mirar.processors.database.database_modifier module
- mirar.processors.database.postgres module
- mirar.processors.database.utils module
- mirar.processors.sqldatabase package
- mirar.processors.utils package
- Submodules
- mirar.processors.utils.cal_hunter module
- mirar.processors.utils.error_annotator module
- mirar.processors.utils.header_annotate module
- mirar.processors.utils.header_reader module
- mirar.processors.utils.image_loader module
- mirar.processors.utils.image_rejector module
- mirar.processors.utils.image_saver module
- mirar.processors.utils.image_selector module
- mirar.processors.utils.multi_ext_parser module
- mirar.processors.utils.simulate_realtime module
- Submodules
- mirar.processors.base_catalog_xmatch_processor module
BaseProcessorWithCrossMatchBaseProcessorWithCrossMatch.base_keyBaseProcessorWithCrossMatch.check_prerequisites()BaseProcessorWithCrossMatch.get_sextractor_apertures()BaseProcessorWithCrossMatch.get_sextractor_module()BaseProcessorWithCrossMatch.setup_catalogs()BaseProcessorWithCrossMatch.write_regions_files()BaseProcessorWithCrossMatch.xmatch_catalogs()
default_image_sextractor_catalog_purifier()
- mirar.processors.base_processor module
BaseImageProcessorBaseProcessorBaseProcessor.apply()BaseProcessor.apply_to_batch()BaseProcessor.base_apply()BaseProcessor.base_keyBaseProcessor.check_prerequisites()BaseProcessor.clean_cache()BaseProcessor.generate_error_report()BaseProcessor.max_n_cpuBaseProcessor.set_night()BaseProcessor.set_preceding_steps()BaseProcessor.subclassesBaseProcessor.update_dataset()
BaseSourceGeneratorBaseSourceProcessorCleanupProcessorImageHandlerNoCandidatesErrorPrerequisiteErrorProcessorPremadeCacheProcessorWithCache
- mirar.processors.bias module
- mirar.processors.cosmic_rays module
- mirar.processors.csvlog module
- mirar.processors.dark module
- mirar.processors.flat module
- mirar.processors.mask module
- mirar.processors.photcal module
- mirar.processors.reference module
- mirar.processors.sky module
- mirar.processors.split module
- mirar.processors.xmatch module
- Subpackages
- mirar.references package
- mirar.utils package
- mirar.catalog package
- Submodules
- mirar.io module
- mirar.paths module
- mirar.testing module
- Subpackages
- mirar package
- mirar.data package