Welcome to SCLUDAM’s documentation!

Python library for star cluster detection and membership estimation.

Contents:

• SCLUDAM (Star CLUster Detection And Membership estimation)
  • Repository and issues
  • Authors
  • Features
  • Requirements
  • User install in a Conda environment (recommended)
  • Update scludam in a Conda environment
  • Simple user install
  • Simple user update
  • Dev install
• Quickstart
  • Main functionality example
  • Documentation quick guide
  • Documentation module guide
• Scludam Modules
  • scludam.detection module
    • default_mask()
    • fast_std_filter()
    • get_histogram_bins()
    • histogram()
    • nyquist_offsets()
    • extend_1dmask()
    • DetectionResult
    • CountPeakDetector
      • CountPeakDetector.detect()
      • CountPeakDetector.plot()
      • CountPeakDetector.lineplot()
  • scludam.fetcher module
    • Config
    • SimbadResult
    • search_object()
    • TableInfo
    • search_table()
    • Query
      • Query.select()
      • Query.top()
      • Query.where()
      • Query.where_or()
      • Query.where_in_circle()
      • Query.where_aen_criterion()
      • Query.where_arenou_criterion()
      • Query.build_count()
      • Query.build()
      • Query.get()
      • Query.count()
    • search_objects_near_data()
    • simbad2gaiacolnames()
  • scludam.hkde module
    • BandwidthSelector
      • BandwidthSelector.get_bw()
    • PluginSelector
      • PluginSelector.get_bw()
    • RuleOfThumbSelector
      • RuleOfThumbSelector.get_bw()
    • HKDE
      • HKDE.set_weights()
      • HKDE.fit()
      • HKDE.pdf()
      • HKDE.plot()
  • scludam.masker module
    • DataMasker
      • DataMasker.mask()
    • RangeMasker
      • RangeMasker.mask()
  • scludam.membership module
    • DBME
      • DBME.fit()
      • DBME.pairplot()
      • DBME.tsneplot()
      • DBME.scatter3dplot()
      • DBME.surfplot()
  • scludam.pipeline module
    • DEP
      • DEP.fit()
      • DEP.proba_df()
      • DEP.write()
      • DEP.cm_diagram()
      • DEP.radec_plot()
      • DEP.scatterplot()
      • DEP.get_simbad_objects()
  • scludam.plots module
    • color_from_proba()
    • scatter3dprobaplot()
    • surfprobaplot()
    • pairprobaplot()
    • tsneprobaplot()
    • heatmap2D()
    • univariate_density_plot()
    • bivariate_density_plot()
    • scatter2dprobaplot()
    • plot_objects()
    • plot_kernels()
    • horizontal_lineplots()
  • scludam.rutils module
    • disable_r_warnings()
    • disable_r_console_output()
    • clean_r_session()
    • load_r_packages()
    • assign_r_args()
  • scludam.shdbscan module
    • SHDBSCAN
      • SHDBSCAN.fit()
      • SHDBSCAN.validity_index()
      • SHDBSCAN.pairplot()
      • SHDBSCAN.tsneplot()
      • SHDBSCAN.scatter3dplot()
      • SHDBSCAN.surfplot()
      • SHDBSCAN.outlierplot()
  • scludam.stat_tests module
    • TestResult
    • StatTest
      • StatTest.test()
    • HopkinsTestResult
    • HopkinsTest
      • HopkinsTest.test()
    • DipDistTestResult
    • DipDistTest
      • DipDistTest.test()
    • RipleyKTestResult
    • RipleysKTest
      • RipleysKTest.test()
  • scludam.synthetic module
    • is_inside_circle()
    • is_inside_sphere()
    • cartesian_to_polar()
    • polar_to_cartesian()
    • EDSD
      • EDSD.pdf()
      • EDSD.cdf()
      • EDSD.ppf()
      • EDSD.rvs()
    • UniformSphere
      • UniformSphere.rvs()
      • UniformSphere.pdf()
    • UniformFrustum
      • UniformFrustum.rvs()
      • UniformFrustum.pdf()
    • UniformCircle
      • UniformCircle.pdf()
      • UniformCircle.rvs()
    • BivariateUniform
      • BivariateUniform.rvs()
      • BivariateUniform.pdf()
    • TrivariateUniform
      • TrivariateUniform.rvs()
      • TrivariateUniform.pdf()
    • StarCluster
      • StarCluster.rvs()
      • StarCluster.pdf()
      • StarCluster.pm_pdf()
      • StarCluster.space_pdf()
    • StarField
      • StarField.rvs()
      • StarField.pdf()
      • StarField.pm_pdf()
      • StarField.space_pdf()
    • Synthetic
      • Synthetic.rvs()
  • scludam.type_utils module
  • scludam.utils module
    • one_hot_encode()
    • Colnames
      • Colnames.exclude()
      • Colnames.data()
      • Colnames.error()
      • Colnames.missing_error()
      • Colnames.corr()
      • Colnames.missing_corr()
  • Module contents
• Software diagrams
  • Dependency diagram
  • Class diagrams

Indices and tables

• Index

• Module Index

• Search Page