Image Events Module Reference
Classes:
|
A class for interacting with Image Events.app. |
|
A monitor connected to the computer. |
|
A wrapper around lists of displays that employs fast enumeration techniques. |
|
An image contained in a file. |
|
A wrapper around lists of images that employs fast enumeration techniques. |
|
A metadata tag: EXIF, IPTC, etc. |
|
A wrapper around lists of metadata tags that employs fast enumeration techniques. |
|
A ColorSync ICC profile. |
|
A wrapper around lists of profiles that employs fast enumeration techniques. |
- class PyXA.apps.ImageEvents.XAImageEventsApplication(properties)[source]
Bases:
XAEventsApplication
,XASBApplication
,XACanOpenPath
A class for interacting with Image Events.app.
New in version 0.1.0.
Classes:
BitDepth
(value)Bit depth options.
ColorSpace
(value)Color space options.
CompressionLevel
(value)Compression options.
ConnectionSpace
(value)Profile connection space options.
DeviceClass
(value)Profile device class options.
FileType
(value)Image file type options.
ImageQuality
(value)Image quality options.
ProfileQuality
(value)Profile quality options.
RenderingIntent
(value)Rendering intent options.
Methods:
aliases
([filter])Returns a list of aliases, as PyXA objects, matching the given filter.
disk_items
([filter])Returns a list of disk items, as PyXA objects, matching the given filter.
disks
([filter])Returns a list of disks, as PyXA objects, matching the given filter.
displays
([filter])Returns a list of displays, as PyXA objects, matching the given filter.
domains
([filter])Returns a list of domains, as PyXA objects, matching the given filter.
file_packages
([filter])Returns a list of file packages, as PyXA objects, matching the given filter.
files
([filter])Returns a list of files, as PyXA objects, matching the given filter.
folders
([filter])Returns a list of folders, as PyXA objects, matching the given filter.
images
([filter])Returns a list of images, as PyXA objects, matching the given filter.
items
([filter])Returns a list of items, as PyXA objects, matching the given filter.
open
(*paths)Opens the disk item at the given filepath.
profiles
([filter])Returns a list of profiles, as PyXA objects, matching the given filter.
Attributes:
The Application Support folder.
The user's Applications folder.
The collection of folders belonging to the Classic System.
The default CMYK profile.
The default CMYK profile location.
The default Gray profile.
The default Gray profile location.
The default Lab profile.
The default Lab profile location.
The default RGB profile.
The default RGB profile location.
The default XYZ profile.
The default XYZ profile location.
The user's Desktop folder.
The Desktop Pictures folder.
The user's Documents folder.
The user's Downloads folder.
The user's Favorites folder.
The user's Folder Action Scripts folder.
The Fonts folder.
Whether Image Events is the frontmost application.
The Home folder of the currently logged in user.
The Library folder.
The collection of folders residing on the Local machine.
The user's Movies folder.
The user's Music folder.
The name of the application.
The collection of folders residing on the Network.
The user's Pictures folder.
The user's Preferences folder.
Specifies preferred Color Management Module to use, or "automatic".
The ColorSync profile folder.
The user's Public folder.
The time in seconds the application will idle before quitting; if set to zero, idle time will not cause the application to quit.
The Scripting Additions folder.
The user's Scripts folder.
The Shared Documents folder.
The user's Sites folder.
The Speakable Items folder.
The disk from which Mac OS X was loaded.
The collection of folders belonging to the System.
The default system profile.
The default system profile location.
The Temporary Items folder.
The user's Trash folder.
The collection of folders belonging to the User.
The Utilities folder.
The version number of the application.
The Automator Workflows folder.
- class BitDepth(value)[source]
Bases:
Enum
Bit depth options.
Attributes:
- BEST = 1650815860
- BLACK_AND_WHITE = 7072447387494217504
- COLOR = 1668246642
- FOUR_COLORS = 878931058
- FOUR_GRAYS = 879194745
- GRAYSCALE = 1735549305
- MILLIONS_OF_COLORS = 1835625580
- MILLIONS_OF_COLORS_PLUS = 1835625515
- SIXTEEN_COLORS = 825647980
- SIXTEEN_GRAYS = 825649010
- THOUSANDS_OF_COLORS = 1953001333
- TWO_HUNDRED_FIFTY_SIX_COLORS = 842348131
- TWO_HUNDRED_FIFTY_SIX_GRAYS = 842348135
- class ColorSpace(value)[source]
Bases:
Enum
Color space options.
Attributes:
- CMYK = 1129142603
- EIGHT_CHANNEL = 1296255032
- EIGHT_COLOR = 943934546
- FIVE_CHANNEL = 1296255029
- FIVE_COLOR = 893602898
- GRAY = 1196573017
- LAB = 1281450528
- NAMED = 1312902469
- RGB = 1380401696
- SEVEN_CHANNEL = 1296255031
- SEVEN_COLOR = 927157330
- SIX_CHANNEL = 1296255030
- SIX_COLOR = 910380114
- XYZ = 1482250784
- class CompressionLevel(value)[source]
Bases:
Enum
Compression options.
Attributes:
- HIGH = 1751738216
- LOW = 1819244320
- MEDIUM = 1835361385
- class ConnectionSpace(value)[source]
Bases:
Enum
Profile connection space options.
Attributes:
- LAB = 1281450528
- XYZ = 1482250784
- class DeviceClass(value)[source]
Bases:
Enum
Profile device class options.
Attributes:
- ABSTRACT = 1633842036
- COLORSPACE = 1936744803
- INPUT = 1935896178
- LINK = 1818848875
- MONITOR = 1835955314
- NAMED = 1852662636
- OUTPUT = 1886549106
- class FileType(value)[source]
Bases:
Enum
Image file type options.
Attributes:
- BMP = 1112363110
- GIF = 1195984416
- JPEG = 1246774599
- JPEG2 = 1785751346
- MACPAINT = 1347310663
- PDF = 1346651680
- PHOTOSHOP = 943870035
- PICT = 1346978644
- PNG = 1347307366
- PSD = 1886610464
- QUICKTIME = 1903454566
- SGI = 777209673
- TEXT = 1413830740
- TGA = 1952932128
- TIFF = 1414088262
- class ImageQuality(value)[source]
Bases:
Enum
Image quality options.
Attributes:
- BEST = 1650815860
- HIGH = 1751738216
- LEAST = 1818583411
- LOW = 1819244320
- MEDIUM = 1835361385
- class ProfileQuality(value)[source]
Bases:
Enum
Profile quality options.
Attributes:
- BEST = 1366647090
- DRAFT = 1366647089
- NORMAL = 1366647088
- class RenderingIntent(value)[source]
Bases:
Enum
Rendering intent options.
Attributes:
- ABSOLUTE_COLORIMETRIC = 1382314547
- PERCEPTUAL = 1382314544
- RELATIVE_COLORIMETRIC = 1378972210
- SATURATION = 1382314546
- aliases(filter: dict | None = None) XAAliasList [source]
Returns a list of aliases, as PyXA objects, matching the given filter.
New in version 0.1.0.
- property application_support_folder: XAFolder
The Application Support folder.
New in version 0.1.0.
- property classic_domain: XAClassicDomainObject
The collection of folders belonging to the Classic System.
New in version 0.1.0.
- property default_cmyk_profile: XAImageEventsProfile
The default CMYK profile.
New in version 0.1.0.
- property default_cmyk_profile_location: XAFile
The default CMYK profile location.
New in version 0.1.0.
- property default_gray_profile: XAImageEventsProfile
The default Gray profile.
New in version 0.1.0.
- property default_gray_profile_location: XAFile
The default Gray profile location.
New in version 0.1.0.
- property default_lab_profile: XAImageEventsProfile
The default Lab profile.
New in version 0.1.0.
- property default_lab_profile_location: XAFile
The default Lab profile location.
New in version 0.1.0.
- property default_rgb_profile: XAImageEventsProfile
The default RGB profile.
New in version 0.1.0.
- property default_rgb_profile_location: XAFile
The default RGB profile location.
New in version 0.1.0.
- property default_xyz_profile: XAImageEventsProfile
The default XYZ profile.
New in version 0.1.0.
- property default_xyz_profile_location: XAFile
The default XYZ profile location.
New in version 0.1.0.
- disk_items(filter: dict | None = None) XADiskItemList [source]
Returns a list of disk items, as PyXA objects, matching the given filter.
New in version 0.1.0.
- disks(filter: dict | None = None) XADiskList [source]
Returns a list of disks, as PyXA objects, matching the given filter.
New in version 0.1.0.
- displays(filter: dict | None = None) XAImageEventsDisplayList [source]
Returns a list of displays, as PyXA objects, matching the given filter.
New in version 0.1.0.
- domains(filter: dict | None = None) XADomainList [source]
Returns a list of domains, as PyXA objects, matching the given filter.
New in version 0.1.0.
- file_packages(filter: dict | None = None) XAFilePackageList [source]
Returns a list of file packages, as PyXA objects, matching the given filter.
New in version 0.1.0.
- files(filter: dict | None = None) XAFileList [source]
Returns a list of files, as PyXA objects, matching the given filter.
New in version 0.1.0.
- property folder_action_scripts_folder: XAFolder
The user’s Folder Action Scripts folder.
New in version 0.1.0.
- folders(filter: dict | None = None) XAFolderList [source]
Returns a list of folders, as PyXA objects, matching the given filter.
New in version 0.1.0.
- property frontmost: bool
Whether Image Events is the frontmost application.
New in version 0.1.0.
- property home_folder: XAFolder
The Home folder of the currently logged in user.
New in version 0.1.0.
- images(filter: dict | None = None) XAImageEventsImageList [source]
Returns a list of images, as PyXA objects, matching the given filter.
New in version 0.1.0.
- items(filter: dict | None = None) XADiskItemList [source]
Returns a list of items, as PyXA objects, matching the given filter.
New in version 0.1.0.
- property local_domain: XALocalDomainObject
The collection of folders residing on the Local machine.
New in version 0.1.0.
- property name: str
The name of the application.
New in version 0.1.0.
- property network_domain: XANetworkDomainObject
The collection of folders residing on the Network.
New in version 0.1.0.
- open(*paths: list[XAPath] | XAPath | str) XAImageEventsImage [source]
Opens the disk item at the given filepath.
- Parameters:
path (Union[list[XABase.XAPath], XABase.XAPath, str]) – The path to a file or the URL to a website to open.
- Returns:
A reference to the opened file, or None if no file was created or it cannot be found
- Return type:
Any
New in version 0.0.1.
- property preferred_cmm: str
Specifies preferred Color Management Module to use, or “automatic”.
New in version 0.1.0.
- profiles(filter: dict | None = None) XAImageEventsProfileList [source]
Returns a list of profiles, as PyXA objects, matching the given filter.
New in version 0.1.0.
- property quit_delay: int
The time in seconds the application will idle before quitting; if set to zero, idle time will not cause the application to quit.
New in version 0.1.0.
- property scripting_additions_folder: XAFolder
The Scripting Additions folder.
New in version 0.1.0.
The Shared Documents folder.
New in version 0.1.0.
- property system_domain: XASystemDomainObject
The collection of folders belonging to the System.
New in version 0.1.0.
- property system_profile: XAImageEventsProfile
The default system profile.
New in version 0.1.0.
- property system_profile_location: XAFile
The default system profile location.
New in version 0.1.0.
- property user_domain: XAUserDomainObject
The collection of folders belonging to the User.
New in version 0.1.0.
- property version: str
The version number of the application.
New in version 0.1.0.
- class PyXA.apps.ImageEvents.XAImageEventsDisplay(properties)[source]
Bases:
XAObject
A monitor connected to the computer.
New in version 0.1.0.
Attributes:
The number of the display.
The profile for the display.
The name of the display.
- property display_number: int
The number of the display.
New in version 0.1.0.
- property display_profile: XAImageEventsProfile
The profile for the display.
New in version 0.1.0.
- property name: str
The name of the display.
New in version 0.1.0.
- class PyXA.apps.ImageEvents.XAImageEventsDisplayList(properties: dict, filter: dict | None = None)[source]
Bases:
XAList
A wrapper around lists of displays that employs fast enumeration techniques.
All properties of displays can be called as methods on the wrapped list, returning a list containing each display’s value for the property.
New in version 0.1.0.
Methods:
by_display_number
(display_number)by_display_profile
(display_profile)by_name
(name)name
()- by_display_number(display_number: int) XAImageEventsDisplay [source]
- by_display_profile(display_profile: XAImageEventsProfile) XAImageEventsDisplay [source]
- by_name(name: str) XAImageEventsDisplay [source]
- display_profile() XAImageEventsProfileList [source]
- class PyXA.apps.ImageEvents.XAImageEventsImage(properties)[source]
Bases:
XAImage
An image contained in a file.
New in version 0.1.0.
Attributes:
Bit depth of the image's color representation.
Color space of the image's color representation.
The width and height of the image, respectively, in pixels.
The profile, if any, embedded in the image.
File type of the image's file.
The file that contains the image.
The folder or disk that encloses the file that contains the image.
The image stored in active memory, including modifications.
The name of the image.
The original image contained in the file, without any modification.
All properties of the image.
The horizontal and vertical pixel density of the image, respectively, in dots per inch.
Methods:
embed_profile
(profile)Embeds the specified ICC profile in the image.
metadata_tags
([filter])Returns a list of metadata tags, as PyXA objects, matching the given filter.
profiles
([filter])Returns a list of profiles, as PyXA objects, matching the given filter.
unembed
()Removes any embedded ICC profiles from the image.
- property color_space: ColorSpace
Color space of the image’s color representation.
New in version 0.1.0.
- property dimensions: tuple[int, int]
The width and height of the image, respectively, in pixels.
New in version 0.1.0.
- embed_profile(profile: XAImageEventsProfile) XAImageEventsImage [source]
Embeds the specified ICC profile in the image.
- Parameters:
profile (XAImageEventsProfile) – The ICC profile to embed in the image
- Returns:
The image object
- Return type:
New in version 0.1.0.
- property embedded_profile: XAImageEventsProfile
The profile, if any, embedded in the image.
New in version 0.1.0.
- property location: XADiskItem
The folder or disk that encloses the file that contains the image.
New in version 0.1.0.
- metadata_tags(filter: dict | None = None) XAImageEventsMetadataTagList [source]
Returns a list of metadata tags, as PyXA objects, matching the given filter.
New in version 0.1.0.
- property modified_image_object: XAImage
The image stored in active memory, including modifications.
- Returns:
The image object stored in active memory
- Return type:
New in version 0.1.0.
- property name: str
The name of the image.
New in version 0.1.0.
- property original_image_object: XAImage
The original image contained in the file, without any modification.
- Returns:
The image object stored in the file
- Return type:
New in version 0.1.0.
- profiles(filter: dict | None = None) XAImageEventsProfileList [source]
Returns a list of profiles, as PyXA objects, matching the given filter.
New in version 0.1.0.
- property properties: Dict
All properties of the image.
New in version 0.1.0.
- property resolution: tuple[float, float]
The horizontal and vertical pixel density of the image, respectively, in dots per inch.
New in version 0.1.0.
- unembed() XAImageEventsImage [source]
Removes any embedded ICC profiles from the image.
- Returns:
The image object
- Return type:
New in version 0.1.0.
- class PyXA.apps.ImageEvents.XAImageEventsImageList(properties: dict, filter: dict | None = None)[source]
Bases:
XAImageList
A wrapper around lists of images that employs fast enumeration techniques.
All properties of images can be called as methods on the wrapped list, returning a list containing each image’s value for the property.
New in version 0.1.0.
Methods:
by_bit_depth
(bit_depth)by_color_space
(color_space)by_dimensions
(dimensions)by_embedded_profile
(embedded_profile)by_file_type
(file_type)by_image_file
(image_file)by_location
(location)by_name
(name)by_resolution
(resolution)embed_profile
(profile)Embeds the specified ICC profile in each image of the list.
location
()name
()unembed
()Removes any embedded ICC profiles from each image of the list.
- bit_depth() list[XAImageEventsApplication.BitDepth] [source]
- by_color_space(color_space: ColorSpace) XAImageEventsImage [source]
- by_dimensions(dimensions: list[int]) XAImageEventsImage [source]
- by_embedded_profile(embedded_profile: XAImageEventsProfile) XAImageEventsImage [source]
- by_file_type(file_type: FileType) XAImageEventsImage [source]
- by_image_file(image_file: XAFile) XAImageEventsImage [source]
- by_location(location: XADiskItem) XAImageEventsImage [source]
- by_name(name: str) XAImageEventsImage [source]
- by_resolution(resolution: list[float]) XAImageEventsImage [source]
- color_space() list[XAImageEventsApplication.ColorSpace] [source]
- embed_profile(profile: XAImageEventsProfile) XAImageList [source]
Embeds the specified ICC profile in each image of the list.
- Parameters:
profile (XAImageEventsProfile) – The ICC profile to embed in the image
- Returns:
The list of modified images
- Return type:
New in version 0.1.0.
- embedded_profile() XAImageEventsProfileList [source]
- file_type() list[XAImageEventsApplication.FileType] [source]
- image_file() XAFileList [source]
- location() list[XABase.XADiskItem] [source]
- modified_image_objects() XAImageList [source]
- original_image_objects() XAImageList [source]
- unembed() XAImageList [source]
Removes any embedded ICC profiles from each image of the list.
- Returns:
The list of modified images
- Return type:
New in version 0.1.0.
- class PyXA.apps.ImageEvents.XAImageEventsMetadataTag(properties)[source]
Bases:
XAObject
A metadata tag: EXIF, IPTC, etc.
New in version 0.1.0.
Attributes:
The description of the tag's function.
The name of the tag.
The current setting of the tag.
- property description: str
The description of the tag’s function.
New in version 0.1.0.
- property name: str
The name of the tag.
New in version 0.1.0.
- property value: bool | int | float | str | XAImageEventsProfile | any
The current setting of the tag.
New in version 0.1.0.
- class PyXA.apps.ImageEvents.XAImageEventsMetadataTagList(properties: dict, filter: dict | None = None)[source]
Bases:
XAList
A wrapper around lists of metadata tags that employs fast enumeration techniques.
All properties of metadata tags can be called as methods on the wrapped list, returning a list containing each tag’s value for the property.
New in version 0.1.0.
Methods:
by_description
(description)by_name
(name)by_value
(value)name
()value
()- by_description(description: str) XAImageEventsMetadataTag [source]
- by_name(name: str) XAImageEventsMetadataTag [source]
- by_value(value: list[bool | int | float | str | XAImageEventsProfile | any]) XAImageEventsMetadataTag [source]
- value() list[bool | int | float | str | XAImageEventsProfile | any] [source]
- class PyXA.apps.ImageEvents.XAImageEventsProfile(properties)[source]
Bases:
XAObject
A ColorSync ICC profile.
New in version 0.1.0.
Attributes:
The color space of the profile.
The connection space of the profile.
The creation date of the profile.
The creator type of the profile.
The device class of the profile.
The device manufacturer of the profile.
The device model of the profile.
The file location of the profile.
The description text of the profile.
The intended platform of the profile.
The preferred CMM of the profile.
The quality of the profile.
The rendering intent of the profile.
The size of the profile in bytes.
The version number of the profile.
- property color_space: ColorSpace
The color space of the profile.
New in version 0.1.0.
- property connection_space: ConnectionSpace
The connection space of the profile.
New in version 0.1.0.
- property creation_date: datetime
The creation date of the profile.
New in version 0.1.0.
- property creator: str
The creator type of the profile.
New in version 0.1.0.
- property device_class: DeviceClass
The device class of the profile.
New in version 0.1.0.
- property device_manufacturer: str
The device manufacturer of the profile.
New in version 0.1.0.
- property device_model: int
The device model of the profile.
New in version 0.1.0.
- property name: str
The description text of the profile.
New in version 0.1.0.
- property platform: str
The intended platform of the profile.
New in version 0.1.0.
- property preferred_cmm: str
The preferred CMM of the profile.
New in version 0.1.0.
- property quality: ProfileQuality
The quality of the profile.
New in version 0.1.0.
- property rendering_intent: RenderingIntent
The rendering intent of the profile.
New in version 0.1.0.
- property size: int
The size of the profile in bytes.
New in version 0.1.0.
- property version: str
The version number of the profile.
New in version 0.1.0.
- class PyXA.apps.ImageEvents.XAImageEventsProfileList(properties: dict, filter: dict | None = None)[source]
Bases:
XAList
A wrapper around lists of profiles that employs fast enumeration techniques.
All properties of profiles can be called as methods on the wrapped list, returning a list containing each profile’s value for the property.
New in version 0.1.0.
Methods:
by_color_space
(color_space)by_connection_space
(connection_space)by_creation_date
(creation_date)by_creator
(creator)by_device_class
(device_class)by_device_manufacturer
(device_manufacturer)by_device_model
(device_model)by_location
(location)by_name
(name)by_platform
(platform)by_preferred_cmm
(preferred_cmm)by_quality
(quality)by_rendering_intent
(rendering_intent)by_size
(size)by_version
(version)creator
()location
()name
()platform
()quality
()size
()version
()- by_color_space(color_space: ColorSpace) XAImageEventsProfile [source]
- by_connection_space(connection_space: ConnectionSpace) XAImageEventsProfile [source]
- by_creation_date(creation_date: datetime) XAImageEventsProfile [source]
- by_creator(creator) XAImageEventsProfile [source]
- by_device_class(device_class: DeviceClass) XAImageEventsProfile [source]
- by_device_manufacturer(device_manufacturer: str) XAImageEventsProfile [source]
- by_device_model(device_model: str) XAImageEventsProfile [source]
- by_location(location: XAAlias) XAImageEventsProfile [source]
- by_name(name: str) XAImageEventsProfile [source]
- by_platform(platform: str) XAImageEventsProfile [source]
- by_preferred_cmm(preferred_cmm: str) XAImageEventsProfile [source]
- by_quality(quality: ProfileQuality) XAImageEventsProfile [source]
- by_rendering_intent(rendering_intent: RenderingIntent) XAImageEventsProfile [source]
- by_size(size: int) XAImageEventsProfile [source]
- by_version(version: str) XAImageEventsProfile [source]
- color_space() list[XAImageEventsApplication.ColorSpace] [source]
- connection_space() list[XAImageEventsApplication.ConnectionSpace] [source]
- device_class() list[XAImageEventsApplication.DeviceClass] [source]
- location() XAAliasList [source]
- quality() list[XAImageEventsApplication.ProfileQuality] [source]
- rendering_intent() list[XAImageEventsApplication.RenderingIntent] [source]