Skip to main content
  • Home
  • Development
  • Documentation
  • Donate
  • Operational login
  • Browse the archive

swh logo
SoftwareHeritage
Software
Heritage
Archive
Features
  • Search

  • Downloads

  • Save code now

  • Add forge now

  • Help

https://github.com/cmu-ci-lab/mcspeckle
30 June 2024, 09:00:48 UTC
  • Code
  • Branches (1)
  • Releases (0)
  • Visits
    • Branches
    • Releases
    • HEAD
    • refs/heads/master
    • c4ecf78f32558cba5e45ab0c43a0995a20f2c85b
    No releases to show
  • a850fae
  • /
  • README.md
Raw File Download
Take a new snapshot of a software origin

If the archived software origin currently browsed is not synchronized with its upstream version (for instance when new commits have been issued), you can explicitly request Software Heritage to take a new snapshot of it.

Use the form below to proceed. Once a request has been submitted and accepted, it will be processed as soon as possible. You can then check its processing state by visiting this dedicated page.
swh spinner

Processing "take a new snapshot" request ...

To reference or cite the objects present in the Software Heritage archive, permalinks based on SoftWare Hash IDentifiers (SWHIDs) must be used.
Select below a type of object currently browsed in order to display its associated SWHID and permalink.

  • content
  • directory
  • revision
  • snapshot
origin badgecontent badge Iframe embedding
swh:1:cnt:c43261d5857de7373fd919ef141c9e8cdbe9820a
origin badgedirectory badge Iframe embedding
swh:1:dir:a850fae5be70dcf06f7a5128670fec06bdfb2bc0
origin badgerevision badge
swh:1:rev:c4ecf78f32558cba5e45ab0c43a0995a20f2c85b
origin badgesnapshot badge
swh:1:snp:3a35cdb24ad67a89d2a1abf099040aff3c71b7b4

This interface enables to generate software citations, provided that the root directory of browsed objects contains a citation.cff or codemeta.json file.
Select below a type of object currently browsed in order to generate citations for them.

  • content
  • directory
  • revision
  • snapshot
Generate software citation in BibTex format (requires biblatex-software package)
Generating citation ...
Generate software citation in BibTex format (requires biblatex-software package)
Generating citation ...
Generate software citation in BibTex format (requires biblatex-software package)
Generating citation ...
Generate software citation in BibTex format (requires biblatex-software package)
Generating citation ...
Tip revision: c4ecf78f32558cba5e45ab0c43a0995a20f2c85b authored by igkiou on 05 September 2019, 11:00:35 UTC
first commit
Tip revision: c4ecf78
README.md
# SCMC: Speckle Covariance and rendering Monte-Carlo solver

A Monte Carlo rendering framework for the physically-accurate simulation of speckle patterns and statistics
arising from volumetric scattering of coherent waves.
This framework allows efficient computation of speckle mean and covariance as well as direct rendering of speckle fields,
for user defined light source directions and detector views. 
Only bulk parameters of the scattering volume are required as input, 
and there is no need to know the specific positions of wavelength-size scatterers in the medium.

Based on : ["A Monte Carlo Framework for Rendering Speckle Statistics in Scattering Media", Bar et.al. (2019)](https://arxiv.org/abs/1901.06931).

## Getting Started

These instructions will get your copy of the SCMC solver up and running on your local machine.

### Prerequisites

The SCMC solver requires MATLAB, available at: 

[https://www.mathworks.com/products/matlab.html](https://www.mathworks.com/products/matlab.html)

The solver was tested on MATLAB 2017b.

### Installing

Download the project code (available in github) to your local machine, and unzip all the files.

**For permanent installation**, add the SCMC folder and all its sub folders to the path, by

```
home -> environment -> set path -> add with Subfolders...
```

and select the SCMC folder. Then, restart MATLAB software.

**For temporal installation**, it is possible to add temporally the SCMS to the path, by adding the line

```
addpath(genpath(' '));
```

to your code, where the path to SCMC folder is inside the quotation marks.

## Running the code

### Interface

The scmc.m is the interface function of the solver.
Refer to the help of scmc.m and the examples folder for proper parameter specifications and usage.

### Examples

Several usage examples and applications are located in the examples subfolder. 
It is recommended to start with these basic examples.

### Assumptions
- The following scattering functions are supported: isotropic, Henyey-Greenstein (HG),
    and a user defined tabulated function.
- This code does not compute speckle mean. As the mean decays exponentially with the optical depth, in most cases it is  negligible. 

### Core code

The core algorithms are implemented in MCcov.m (evaluating speckle covariance) and MCfield.m (sampling a spackle field), which are located in code subfolder.

## Authors

* **Chen Bar** - *Department of Electrical Engeneering, Technion, Israel*
* **Marina Alterman** - *Department of Electrical Engeneering, Technion, Israel*
* [**Ioannis Gkioulekas**](http://www.cs.cmu.edu/~igkioule/) - *Robotics Institute, CMU, USA.*
* [**Anat Levin**](http://webee.technion.ac.il/people/anat.levin/) - *Department of Electrical Engeneering, Technion, Israel*

## License

This project is licensed under the ???

## Acknowledgments

* ?!?!?

back to top

Software Heritage — Copyright (C) 2015–2025, The Software Heritage developers. License: GNU AGPLv3+.
The source code of Software Heritage itself is available on our development forge.
The source code files archived by Software Heritage are available under their own copyright and licenses.
Terms of use: Archive access, API— Content policy— Contact— JavaScript license information— Web API