API Reference

The main entry point to start working with RAW images is rawpy.imread(). It returns a rawpy.RawPy object on which all further operations have to be performed.

rawpy.imread(pathOrFile: str | BinaryIO, shot_select: int = 0) → RawPy

Convenience function that creates a rawpy.RawPy instance, opens the given file, and returns the rawpy.RawPy instance for further processing.

Parameters:

• pathOrFile (str or file-like object) – path or file object of RAW image that will be read

• shot_select (int) – select which image to extract from RAW files that contain multiple images (e.g., Dual Pixel RAW). Default is 0 for the first/main image.

Returns:

RawPy instance with the opened RAW image

Return type:

rawpy.RawPy

• Classes
  • RawPy
  • Params
• Exceptions
  • NotSupportedError
  • LibRawError
  • LibRawFatalError
  • LibRawNonFatalError
• Enumerations
  • RawType
  • ThumbFormat
  • DemosaicAlgorithm
  • ColorSpace
  • HighlightMode
  • FBDDNoiseReductionMode
• Named Tuples
  • ImageSizes
  • Thumbnail
  • Other
  • Lens
• Modules
  • enhance