The cl-photo Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-photo Reference Manual

This is the cl-photo Reference Manual, version 1.0, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 08:13:47 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

See doc/readme.html for a brief introduction.

 


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

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

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 cl-photo.asd

Location

cl-photo.asd

Systems

cl-photo (system)

Packages

cl-photo-system


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 cl-photo/package.lisp

Parent

cl-photo (system)

Location

package.lisp

Packages

cl-photo


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 cl-photo/convert.lisp

Dependency

package.lisp (file)

Parent

cl-photo (system)

Location

convert.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.4 cl-photo/cameras.lisp

Dependency

convert.lisp (file)

Parent

cl-photo (system)

Location

cameras.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.5 cl-photo/fov.lisp

Dependency

cameras.lisp (file)

Parent

cl-photo (system)

Location

fov.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.6 cl-photo/dof.lisp

Dependency

fov.lisp (file)

Parent

cl-photo (system)

Location

dof.lisp

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.7 cl-photo/tables.lisp

Dependencies
Parent

cl-photo (system)

Location

tables.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

4.1 cl-photo-system

Source

cl-photo.asd

Use List

Previous: , Up: Packages   [Contents][Index]

4.2 cl-photo

Source

package.lisp (file)

Nickname

photo

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Previous: , Up: Exported definitions   [Contents][Index]

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)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Constants

Constant: +inches->mm+
Package

cl-photo

Source

convert.lisp (file)

Constant: +radian->degrees+
Package

cl-photo

Source

convert.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Previous: , Up: Internal definitions   [Contents][Index]

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)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-photo.asd: The cl-photo<dot>asd file
cl-photo/cameras.lisp: The cl-photo/cameras<dot>lisp file
cl-photo/convert.lisp: The cl-photo/convert<dot>lisp file
cl-photo/dof.lisp: The cl-photo/dof<dot>lisp file
cl-photo/fov.lisp: The cl-photo/fov<dot>lisp file
cl-photo/package.lisp: The cl-photo/package<dot>lisp file
cl-photo/tables.lisp: The cl-photo/tables<dot>lisp file

F
File, Lisp, cl-photo.asd: The cl-photo<dot>asd file
File, Lisp, cl-photo/cameras.lisp: The cl-photo/cameras<dot>lisp file
File, Lisp, cl-photo/convert.lisp: The cl-photo/convert<dot>lisp file
File, Lisp, cl-photo/dof.lisp: The cl-photo/dof<dot>lisp file
File, Lisp, cl-photo/fov.lisp: The cl-photo/fov<dot>lisp file
File, Lisp, cl-photo/package.lisp: The cl-photo/package<dot>lisp file
File, Lisp, cl-photo/tables.lisp: The cl-photo/tables<dot>lisp file

L
Lisp File, cl-photo.asd: The cl-photo<dot>asd file
Lisp File, cl-photo/cameras.lisp: The cl-photo/cameras<dot>lisp file
Lisp File, cl-photo/convert.lisp: The cl-photo/convert<dot>lisp file
Lisp File, cl-photo/dof.lisp: The cl-photo/dof<dot>lisp file
Lisp File, cl-photo/fov.lisp: The cl-photo/fov<dot>lisp file
Lisp File, cl-photo/package.lisp: The cl-photo/package<dot>lisp file
Lisp File, cl-photo/tables.lisp: The cl-photo/tables<dot>lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   %  
A   B   C   D   E   F   G   H   I   L   M   N   O   P   R   S  
Index Entry  Section

%
%fov: Internal functions

A
aov: Exported functions
aov-format: Exported functions
aov-one-dim: Internal functions
aov-table: Exported functions

B
bellows-factor: Exported functions

C
close-up: Exported functions
coc: Exported functions
coc-airy: Exported functions
coc-format: Exported functions
coc-pixels: Exported functions
coc-pixels-format: Exported functions

D
degrees->radians: Internal functions
diagonal: Internal functions
dof: Exported functions
dof-mm: Internal functions
dof-symmetric-mm: Internal functions
dof-table: Exported functions

E
effective-aperture: Exported functions
extension-tube: Exported functions

F
feet->mm: Internal functions
find-format: Internal functions
format-match-p: Internal functions
fov: Exported functions
fov-table: Exported functions
Function, %fov: Internal functions
Function, aov: Exported functions
Function, aov-format: Exported functions
Function, aov-one-dim: Internal functions
Function, aov-table: Exported functions
Function, bellows-factor: Exported functions
Function, close-up: Exported functions
Function, coc: Exported functions
Function, coc-airy: Exported functions
Function, coc-format: Exported functions
Function, coc-pixels: Exported functions
Function, coc-pixels-format: Exported functions
Function, degrees->radians: Internal functions
Function, diagonal: Internal functions
Function, dof: Exported functions
Function, dof-mm: Internal functions
Function, dof-symmetric-mm: Internal functions
Function, dof-table: Exported functions
Function, effective-aperture: Exported functions
Function, extension-tube: Exported functions
Function, feet->mm: Internal functions
Function, find-format: Internal functions
Function, format-match-p: Internal functions
Function, fov: Exported functions
Function, fov-table: Exported functions
Function, gaussian-lens: Exported functions
Function, hyperfocal: Exported functions
Function, hyperfocal-table: Exported functions
Function, image-distance-magnification: Internal functions
Function, imager-dimensions: Exported functions
Function, inches->mm: Internal functions
Function, length->mm: Internal functions
Function, magnification: Exported functions
Function, make-output-format: Internal functions
Function, maximum-sharpness-aperture: Exported functions
Function, mm->feet: Internal functions
Function, mm->inches: Internal functions
Function, mm->length: Internal functions
Function, mtf-scanner: Internal functions
Function, n-args-not-nil: Internal functions
Function, output-dimensions: Exported functions
Function, pixel-dimensions: Exported functions
Function, pixel-size: Exported functions
Function, print-magnification: Exported functions
Function, radians->degrees: Internal functions
Function, rayleigh-limit: Exported functions
Function, sensor-dimensions-megapixels: Internal functions
Function, sort-formats: Internal functions
Function, sort-size: Internal functions

G
gaussian-lens: Exported functions

H
hyperfocal: Exported functions
hyperfocal-table: Exported functions

I
image-distance-magnification: Internal functions
imager-dimensions: Exported functions
inches->mm: Internal functions

L
length->mm: Internal functions

M
magnification: Exported functions
make-output-format: Internal functions
maximum-sharpness-aperture: Exported functions
mm->feet: Internal functions
mm->inches: Internal functions
mm->length: Internal functions
mtf-scanner: Internal functions

N
n-args-not-nil: Internal functions

O
output-dimensions: Exported functions

P
pixel-dimensions: Exported functions
pixel-size: Exported functions
print-magnification: Exported functions

R
radians->degrees: Internal functions
rayleigh-limit: Exported functions

S
sensor-dimensions-megapixels: Internal functions
sort-formats: Internal functions
sort-size: Internal functions

Jump to:   %  
A   B   C   D   E   F   G   H   I   L   M   N   O   P   R   S  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *   +  
C   S  
Index Entry  Section

*
*cameras*: Exported special variables
*digital-cameras*: Exported special variables

+
+distances-feet+: Internal special variables
+f-stops+: Internal special variables
+focal-lengths+: Internal special variables
+format-db+: Internal special variables
+inches->mm+: Internal constants
+radian->degrees+: Internal constants

C
Constant, +inches->mm+: Internal constants
Constant, +radian->degrees+: Internal constants

S
Special Variable, *cameras*: Exported special variables
Special Variable, *digital-cameras*: Exported special variables
Special Variable, +distances-feet+: Internal special variables
Special Variable, +f-stops+: Internal special variables
Special Variable, +focal-lengths+: Internal special variables
Special Variable, +format-db+: Internal special variables

Jump to:   *   +  
C   S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
cl-photo: The cl-photo system
cl-photo: The cl-photo package
cl-photo-system: The cl-photo-system package

P
Package, cl-photo: The cl-photo package
Package, cl-photo-system: The cl-photo-system package

S
System, cl-photo: The cl-photo system

Jump to:   C   P   S