The cl-photo Reference Manual

Table of Contents

The cl-photo Reference Manual

This is the cl-photo Reference Manual, version 1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 12:39:29 2020 GMT+0.

1 Introduction

See doc/readme.html for a brief introduction.

 

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 cl-photo

Maintainer

Kevin M. Rosenberg <kmr@debian.org>

Author

Kevin M. Rosenberg <kevin@rosenberg.net>

License

GNU General Public License

Description

Lisp Markup Language

Long Description

cl-photo calculates photography values.

Version

1.0

Dependency

kmrcl

Source

cl-photo.asd (file)

Components

• package.lisp (file)
• convert.lisp (file)
• cameras.lisp (file)
• fov.lisp (file)
• dof.lisp (file)
• tables.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 cl-photo.asd

Location

cl-photo.asd

Systems

cl-photo (system)

Packages

cl-photo-system

3.1.2 cl-photo/package.lisp

Parent

cl-photo (system)

Location

package.lisp

Packages

cl-photo

3.1.3 cl-photo/convert.lisp

Dependency

package.lisp (file)

Parent

cl-photo (system)

Location

convert.lisp

Internal Definitions

• +inches->mm+ (constant)
• +radian->degrees+ (constant)
• degrees->radians (function)
• diagonal (function)
• feet->mm (function)
• inches->mm (function)
• length->mm (function)
• mm->feet (function)
• mm->inches (function)
• mm->length (function)
• radians->degrees (function)

3.1.4 cl-photo/cameras.lisp

Dependency

convert.lisp (file)

Parent

cl-photo (system)

Location

cameras.lisp

Exported Definitions

• *cameras* (special variable)
• *digital-cameras* (special variable)
• imager-dimensions (function)
• output-dimensions (function)
• pixel-dimensions (function)
• pixel-size (function)

Internal Definitions

• +format-db+ (special variable)
• find-format (function)
• format-match-p (function)
• make-output-format (function)
• sensor-dimensions-megapixels (function)
• sort-formats (function)

3.1.5 cl-photo/fov.lisp

Dependency

cameras.lisp (file)

Parent

cl-photo (system)

Location

fov.lisp

Exported Definitions

• aov (function)
• aov-format (function)
• bellows-factor (function)
• close-up (function)
• extension-tube (function)
• fov (function)
• gaussian-lens (function)
• magnification (function)

Internal Definitions

• %fov (function)
• aov-one-dim (function)
• image-distance-magnification (function)
• n-args-not-nil (function)

3.1.6 cl-photo/dof.lisp

Dependency

fov.lisp (file)

Parent

cl-photo (system)

Location

dof.lisp

Exported Definitions

• coc (function)
• coc-airy (function)
• coc-format (function)
• coc-pixels (function)
• coc-pixels-format (function)
• dof (function)
• effective-aperture (function)
• hyperfocal (function)
• maximum-sharpness-aperture (function)
• print-magnification (function)
• rayleigh-limit (function)

Internal Definitions

• dof-mm (function)
• dof-symmetric-mm (function)
• mtf-scanner (function)
• sort-size (function)

3.1.7 cl-photo/tables.lisp

Dependencies

• dof.lisp (file)
• fov.lisp (file)

Parent

cl-photo (system)

Location

tables.lisp

Exported Definitions

• aov-table (function)
• dof-table (function)
• fov-table (function)
• hyperfocal-table (function)

Internal Definitions

• +distances-feet+ (special variable)
• +f-stops+ (special variable)
• +focal-lengths+ (special variable)

4 Packages

Packages are listed by definition order.

4.1 cl-photo-system

Source

cl-photo.asd

Use List

• common-lisp
• asdf/interface

4.2 cl-photo

Source

package.lisp (file)

Nickname

photo

Use List

• kmrcl
• common-lisp

Exported Definitions

• *cameras* (special variable)
• *digital-cameras* (special variable)
• aov (function)
• aov-format (function)
• aov-table (function)
• bellows-factor (function)
• close-up (function)
• coc (function)
• coc-airy (function)
• coc-format (function)
• coc-pixels (function)
• coc-pixels-format (function)
• dof (function)
• dof-table (function)
• effective-aperture (function)
• extension-tube (function)
• fov (function)
• fov-table (function)
• gaussian-lens (function)
• hyperfocal (function)
• hyperfocal-table (function)
• imager-dimensions (function)
• magnification (function)
• maximum-sharpness-aperture (function)
• output-dimensions (function)
• pixel-dimensions (function)
• pixel-size (function)
• print-magnification (function)
• rayleigh-limit (function)

Internal Definitions

• %fov (function)
• +distances-feet+ (special variable)
• +f-stops+ (special variable)
• +focal-lengths+ (special variable)
• +format-db+ (special variable)
• +inches->mm+ (constant)
• +radian->degrees+ (constant)
• aov-one-dim (function)
• degrees->radians (function)
• diagonal (function)
• dof-mm (function)
• dof-symmetric-mm (function)
• feet->mm (function)
• find-format (function)
• format-match-p (function)
• image-distance-magnification (function)
• inches->mm (function)
• length->mm (function)
• make-output-format (function)
• mm->feet (function)
• mm->inches (function)
• mm->length (function)
• mtf-scanner (function)
• n-args-not-nil (function)
• radians->degrees (function)
• sensor-dimensions-megapixels (function)
• sort-formats (function)
• sort-size (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *cameras*

Package

cl-photo

Source

cameras.lisp (file)

Special Variable: *digital-cameras*

Package

cl-photo

Source

cameras.lisp (file)

5.1.2 Functions

Function: aov FOCAL-LENGTH FRAME-WIDTH FRAME-HEIGHT &key PROJECTION MAGNIFICATION

Returns the angle of field of view for a focal length and frame size. Default is infinity (magnification 0)

Package

cl-photo

Source

fov.lisp (file)

Function: aov-format FOCAL-LENGTH FORMAT &key PROJECTION

Returns the angle of field of view for a focal length and frame size at infinity

Package

cl-photo

Source

fov.lisp (file)

Function: aov-table IMAGER &key OUTPUT PROJECTION

Package

cl-photo

Source

tables.lisp (file)

Function: bellows-factor FOCAL-LENGTH OBJECT-DISTANCE

Returns the bellows factor, the ratio of effective aperature to actual aperture.

Package

cl-photo

Source

fov.lisp (file)

Function: close-up &key FOCAL-LENGTH OBJECT-DISTANCE IMAGE-DISTANCE MAGNIFICATION UNITS

Computes the parameters for focusing closer than infinity.
Requires two, and only two, of the input parameters.
Returns: focal-length object-distance image-distance magnification bellows-factor.

Package

cl-photo

Source

fov.lisp (file)

Function: coc IMAGER-SIZE &key LPM MINIMUM-DISTANCE VIEWING-DISTANCE PRINT-SIZE

Returns circle of confusion in mm and print magnification for a format. Default resolving power is 5 lpm at 25cm.

Package

cl-photo

Source

dof.lisp (file)

Function: coc-airy F-STOP &optional WAVELENGTH

Return the circle of confusion based on the airy disk.

Package

cl-photo

Source

dof.lisp (file)

Function: coc-format FORMAT &key LPM MINIMUM-DISTANCE VIEWING-DISTANCE PRINT-SIZE

Returns circle of confusion in mm and print magnification for a format. Default resolving power is 5 lpm at 25cm.

Package

cl-photo

Source

dof.lisp (file)

Function: coc-pixels IMAGER PIXELS

Returns lpm and circle of confusion based on pixel size.

Package

cl-photo

Source

dof.lisp (file)

Function: coc-pixels-format FORMAT

Returns circle of confusion based on pixel size.

Package

cl-photo

Source

dof.lisp (file)

Function: dof FOCAL-LENGTH F-STOP DISTANCE COC &key UNITS PUPIL-FACTOR

Returns the Depth of Field.
Input: FOCAL-LENGTH, F-STOP, DISTANCE, CIRCLE-OF-CONFUSION.
Output: NEAR-POINT, FAR-POINT, TOTAL-DOF, MAGNIFICATION, BLUR-SIZE-OF-INFINITY-POINT-IN-MM.

Package

cl-photo

Source

dof.lisp (file)

Function: dof-table FOCAL-LENGTH COC &key OUTPUT UNITS

Package

cl-photo

Source

tables.lisp (file)

Function: effective-aperture FOCAL-LENGTH DISTANCE APERTURE

Package

cl-photo

Source

dof.lisp (file)

Function: extension-tube FOCAL-LENGTH &key ORIGINAL-OBJECT-DISTANCE ORIGINAL-IMAGE-DISTANCE ORIGINAL-MAGNIFICATION NEW-OBJECT-DISTANCE NEW-IMAGE-DISTANCE NEW-MAGNIFICATION EXTENSION-LENGTH UNITS

Computes the parameters for using extension tubes.
Requires: 1. original-object-distance, original-image-distance, or original-magnification
2. new-object-distance, new-image-distance, new-magnification, or extension-length
Returns: original-object-distance, original-image-distance, original-magnification, original-bellows-factor new-object-distance, new-image-distance, new-magnification, extension-length.

Package

cl-photo

Source

fov.lisp (file)

Function: fov FOCAL-LENGTH FRAME-WIDTH FRAME-HEIGHT &key OBJECT-DISTANCE IMAGE-DISTANCE MAGNIFICATION UNITS PROJECTION

Package

cl-photo

Source

fov.lisp (file)

Function: fov-table IMAGER FOCAL-LENGTH &key OUTPUT PROJECTION UNITS

Package

cl-photo

Source

tables.lisp (file)

Function: gaussian-lens &key OBJECT-DISTANCE IMAGE-DISTANCE FOCAL-LENGTH UNITS

object-distance is in units. image-distance and focal-length are in mm.

Package

cl-photo

Source

fov.lisp (file)

Function: hyperfocal FOCAL-LENGTH F-STOP COC &key UNITS

Package

cl-photo

Source

dof.lisp (file)

Function: hyperfocal-table FOCAL-LENGTH COC &key UNITS OUTPUT

Package

cl-photo

Source

tables.lisp (file)

Function: imager-dimensions FORMAT-SPEC

Returns the imager dimensions in mm of a FORMAT.

Package

cl-photo

Source

cameras.lisp (file)

Function: magnification &key FOCAL-LENGTH OBJECT-DISTANCE IMAGE-DISTANCE UNITS

Returns the image magnification: the ratio of image size to object size. focal-length and image-distance are in mm, object-distance is in units

Package

cl-photo

Source

fov.lisp (file)

Function: maximum-sharpness-aperture FORMAT &optional WAVELENGTH

Package

cl-photo

Source

dof.lisp (file)

Function: output-dimensions FORMAT-SPEC

Returns the output dimensions in mm of a FORMAT.

Package

cl-photo

Source

cameras.lisp (file)

Function: pixel-dimensions SENSOR-SPEC &key FORMAT

Returns the number of pixels for a format.
CAMERA-SPEC is either a keyword designating the camera or
the number of megapixels of the sensor.
FORMAT should be defined if the CAMERA-SPEC is the number of megapixels so the proper aspect ratio is used.

Package

cl-photo

Source

cameras.lisp (file)

Function: pixel-size FORMAT-SPEC

Return pixel size in micrometers.

Package

cl-photo

Source

cameras.lisp (file)

Function: print-magnification IMAGER-SIZE PRINT-SIZE

Returns the magnification required between an imager and print sizes while taking crop into consideration.

Package

cl-photo

Source

dof.lisp (file)

Function: rayleigh-limit F-STOP &optional WAVELENGTH

Returns the rayleigh limit in line pairs per mm (MTF 9%) as well as the MTF50

Package

cl-photo

Source

dof.lisp (file)

5.2 Internal definitions

5.2.1 Constants

Constant: +inches->mm+

Package

cl-photo

Source

convert.lisp (file)

Constant: +radian->degrees+

Package

cl-photo

Source

convert.lisp (file)

5.2.2 Special variables

Special Variable: +distances-feet+

Package

cl-photo

Source

tables.lisp (file)

Special Variable: +f-stops+

Package

cl-photo

Source

tables.lisp (file)

Special Variable: +focal-lengths+

Package

cl-photo

Source

tables.lisp (file)

Special Variable: +format-db+

Package

cl-photo

Source

cameras.lisp (file)

5.2.3 Functions

Function: %fov FOCAL-LENGTH FRAME-WIDTH FRAME-HEIGHT OBJECT-DISTANCE IMAGE-DISTANCE UNITS &optional PROJECTION

Returns the field of view (units), magnification ratio, object-distance (units), and image distance (mm) for a given image (mm) and object distance (mm).

Package

cl-photo

Source

fov.lisp (file)

Function: aov-one-dim FOCAL-LENGTH FRAME-SIZE &key PROJECTION MAGNIFICATION

Returns the angle of view in one dimension. Default is infinity which has an magnification of 0.

Package

cl-photo

Source

fov.lisp (file)

Function: degrees->radians R

Package

cl-photo

Source

convert.lisp (file)

Function: diagonal X Y

Package

cl-photo

Source

convert.lisp (file)

Function: dof-mm FOCAL-LENGTH F-STOP DISTANCE COC &key PUPIL-FACTOR

Returns depth of field based on focal-length, f-stop, distance, and coc. Six values are returned:
near point, far point, total dof, magnification, blur size at infinity (mm). Circle of confusion can either be a number or keyword designating format. Reference: http://www.vanwalree.com/optics/dofderivation.html

Package

cl-photo

Source

dof.lisp (file)

Function: dof-symmetric-mm FOCAL-LENGTH F-STOP DISTANCE COC

Returns depth of field based on focal-length, f-stop, distance, and coc. Six values are returned:
near point, far point, total dof, near point, far point, magnification, blur size at infinity (mm).
Circle of confusion can either be a number or keyword designating format.

Package

cl-photo

Source

dof.lisp (file)

Function: feet->mm D

Package

cl-photo

Source

convert.lisp (file)

Function: find-format FORMAT-SPEC

Package

cl-photo

Source

cameras.lisp (file)

Function: format-match-p FORMAT-SPEC FORMAT

Package

cl-photo

Source

cameras.lisp (file)

Function: image-distance-magnification FOCAL-LENGTH MAGNIFICATION

Returns the image distance for a focused object at distance using the Gaussian Lens Equation.

Package

cl-photo

Source

fov.lisp (file)

Function: inches->mm D

Package

cl-photo

Source

convert.lisp (file)

Function: length->mm D UNITS

Convert a length in units to mm.

Package

cl-photo

Source

convert.lisp (file)

Function: make-output-format W H &key UNITS

Package

cl-photo

Source

cameras.lisp (file)

Function: mm->feet D

Package

cl-photo

Source

convert.lisp (file)

Function: mm->inches D

Package

cl-photo

Source

convert.lisp (file)

Function: mm->length D UNITS

Convert a number of mm to units.

Package

cl-photo

Source

convert.lisp (file)

Function: mtf-scanner FREQ DSCAN-FREQ &optional ORDER

Package

cl-photo

Source

dof.lisp (file)

Function: n-args-not-nil N &rest ARGS

Returns T when count N of input args are not nil.

Package

cl-photo

Source

fov.lisp (file)

Function: radians->degrees R

Package

cl-photo

Source

convert.lisp (file)

Function: sensor-dimensions-megapixels FORMAT MEGAPIXELS

Package

cl-photo

Source

cameras.lisp (file)

Function: sort-formats FORMATS

Package

cl-photo

Source

cameras.lisp (file)

Function: sort-size SIZE

Returns a cons pair with the smaller size first.

Package

cl-photo

Source

dof.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types