# Frequency Estimation

**Repository Path**: vxyi/freqest

## Basic Information

- **Project Name**: Frequency Estimation
- **Description**: Micro-Oscillation Frequency Estimation of Optical Point Sources Using Spatial Mode Demultiplexing
- **Primary Language**: Unknown
- **License**: CC-BY-4.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-10-18
- **Last Updated**: 2025-12-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# README
## Intro

The raw data is quite large (approximately 413 GB before compression). As a result, the raw data is not publicly available at this time but may be obtained from the authors upon reasonable request.

**NOTE:** Not all raw data was used for estimation. The data actually used for estimation has been cropped and is available in the `estimates` Python instance.


## Usage

```Python
from src import *

c = LoadEstimates('data/...') # Name a .npz file
c.cropped_data # Cropped data
c.estimates # Frequency estimates
```


## Flowchart


```mermaid
graph TD
  R[Raw 2D Image] -->|Crop to 1D| C[Cropped Data]
  R -->|Reign without Signal| Np[Noise Photons]
  
  Np --> Sb(Subtraction)
  C --> Sb
  Sb --> Sp[Singal Photons]

  Np --> Ml(MLE of Location)
  Sp --> Ml
  C --> Ml

  Ml --> Td[Time Domain]
  Td --> Mf(LSE of Frequency)
  Mf --> E[Estimates]
  
  E -->|Repeat| V[Variance of Estimates]
  V --> Cp(Multiplication)
  Sp --> Cp
  
  Cp --> Final[Variance per Signal Photon]


```