Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
guillermoaguilar committed Apr 10, 2020
1 parent 4165445 commit 7bab0f8
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
@@ -1,20 +1,21 @@
# Stimuli

Contains submodules for
- creating different stimuli used in lightness perception ([lightness](src/README.md))
- creating different stimuli used in lightness perception ([lightness](src/README.md#lightness))
- creating 2D patterns or renderings of 3D checkerboards with transparent
layers covering part of the image ([transparency](src/transparency/README.md))
- creating different random and deterministic textures ([texture](src/texture/README.md))
- some helper functions for padding, resizing, computing Munsell values, and
converting pixel values to degrees of visual angle ([utils](src/README.md))
- various functions that calculate contrast metrics ([contrast_metrics](src/README.md#contrast-metrics))
- some helper functions for padding, resizing, computing Munsell values, and
converting pixel values to degrees of visual angle ([utils](src/README.md#utils))


For details, please refer to the source directory (src/), the respective subdirectories and the docstrings.

## Dependencies
- Required: numpy, matplotlib, PIL
- Optional:
- PovRay (to render variegated checkerboards - submodule transparency.CheckerboardFactory])
- [PovRay](http://www.povray.org/) (to render variegated checkerboards - submodule transparency.CheckerboardFactory])
- rpy2 and R (to render textures with specific spatial properties - submodule texture)


Expand All @@ -37,7 +38,7 @@ To use in your own code, import the modules. See READMEs in src/ for example usa
from stimuli import lightness
from stimuli.transparency import TextureFactory
from stimuli.transparency import CheckerboardFactory
from stimuli import contrast_measures as cm
from stimuli import contrast_metrics as cm
from stimuli import utils
# (other modules are yet to be fixed)
```

0 comments on commit 7bab0f8

Please sign in to comment.